[Olena-patches] olena-2.0-13-gd88afde First draft of unified doc.

--- configure.ac | 2 + doc/.gitignore | 9 + doc/Doxyfile.in | 361 +++++++++ doc/DoxygenLayout.xml | 184 +++++ doc/Makefile.am | 155 ++++ doc/doxygen.css | 856 ++++++++++++++++++++ doc/footer.html | 5 + doc/header.html | 46 ++ doc/logo.jpg | Bin 0 -> 7477 bytes doc/mainpage.hh | 38 + doc/olena.qhcp | 12 + doc/subdoc_footer.html | 6 + milena/doc/Doxyfile.in | 42 +- milena/doc/DoxygenLayout.xml | 184 +++++ milena/doc/milena.qhcp | 11 + scribo/doc/.gitignore | 13 + scribo/doc/Doxyfile.in | 373 +++++++++ scribo/doc/DoxygenLayout.xml | 184 +++++ scribo/doc/Makefile.am | 250 ++++++ {milena => scribo}/doc/doxyfuns.sty | 0 .../doc/examples-outputs.mk | 0 scribo/doc/examples.mk | 4 + .../doc/examples/dummy.cc | 0 .../doc/figures.mk | 0 {milena => scribo}/doc/gen-examples-outputs-mk | 0 {milena => scribo}/doc/gen-figures-mk | 0 {milena => scribo}/doc/gen-make-variable | 0 {milena => scribo}/doc/gen-split-examples-mk | 0 {milena => scribo}/doc/gen-split-outputs-mk | 0 {milena => scribo}/doc/graphicx.hva | 0 scribo/doc/outputs.mk | 4 + .../doc/outputs/dummy.txt | 0 .../doc/programs-examples.mk | 0 scribo/doc/scribo.qhcp | 11 + milena/doc/milena.sty => scribo/doc/scribo.sty | 0 .../doc/split-examples.mk | 0 .../doc/split-outputs.mk | 0 {milena => scribo}/doc/tools/todoxygen.sh | 0 .../doc/tutorial.tex | 0 39 files changed, 2735 insertions(+), 15 deletions(-) create mode 100644 doc/.gitignore create mode 100644 doc/Doxyfile.in create mode 100644 doc/DoxygenLayout.xml create mode 100644 doc/Makefile.am create mode 100644 doc/doxygen.css create mode 100644 doc/footer.html create mode 100644 doc/header.html create mode 100644 doc/logo.jpg create mode 100644 doc/mainpage.hh create mode 100644 doc/olena.qhcp create mode 100644 doc/subdoc_footer.html create mode 100644 milena/doc/DoxygenLayout.xml create mode 100644 milena/doc/milena.qhcp create mode 100644 scribo/doc/.gitignore create mode 100644 scribo/doc/Doxyfile.in create mode 100644 scribo/doc/DoxygenLayout.xml create mode 100644 scribo/doc/Makefile.am copy {milena => scribo}/doc/doxyfuns.sty (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/examples-outputs.mk (100%) create mode 100644 scribo/doc/examples.mk copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/examples/dummy.cc (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/figures.mk (100%) copy {milena => scribo}/doc/gen-examples-outputs-mk (100%) copy {milena => scribo}/doc/gen-figures-mk (100%) copy {milena => scribo}/doc/gen-make-variable (100%) copy {milena => scribo}/doc/gen-split-examples-mk (100%) copy {milena => scribo}/doc/gen-split-outputs-mk (100%) copy {milena => scribo}/doc/graphicx.hva (100%) create mode 100644 scribo/doc/outputs.mk copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/outputs/dummy.txt (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/programs-examples.mk (100%) create mode 100644 scribo/doc/scribo.qhcp copy milena/doc/milena.sty => scribo/doc/scribo.sty (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/split-examples.mk (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/split-outputs.mk (100%) copy {milena => scribo}/doc/tools/todoxygen.sh (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/tutorial.tex (100%) diff --git a/configure.ac b/configure.ac index a53bcf8..d07ecdb 100644 --- a/configure.ac +++ b/configure.ac @@ -339,6 +339,7 @@ AC_CONFIG_FILES([ scribo/demo/review/Makefile scribo/demo/viewer/Makefile scribo/demo/xml2doc/Makefile + scribo/doc/Makefile scribo/src/Makefile scribo/src/binarization/Makefile scribo/src/contest/Makefile @@ -406,6 +407,7 @@ AC_CONFIG_FILES([milena/doc/tools/data.hh]) # Ask for the Makefile creations. AC_CONFIG_FILES([ Makefile + doc/Makefile external/Makefile milena/Makefile milena/doc/Makefile diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..9b600ce --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,9 @@ +/Doxyfile_user +/user-refman +/user-refman.pdf + +/Doxyfile_devel +/devel-refman +/devel-refman.pdf + +/figures/*.png diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in new file mode 100644 index 0000000..106c58c --- /dev/null +++ b/doc/Doxyfile.in @@ -0,0 +1,361 @@ +# Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +# +# This file is part of Olena. +# +# Olena is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, version 2 of the License. +# +# Olena is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Olena. If not, see <http://www.gnu.org/licenses/>. +# +# Doxyfile 1.5.1 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "Olena" +PROJECT_NUMBER = "@PACKAGE_VERSION@" +PROJECT_BRIEF = "An Image Processing Platform" +PROJECT_LOGO = @top_srcdir@/doc/logo.jpg +OUTPUT_DIRECTORY = @builddir@/user-refman.tmp +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = @top_srcdir@ +STRIP_FROM_INC_PATH = +SHORT_NAMES = YES +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +BUILTIN_STL_SUPPORT = YES +IDL_PROPERTY_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = YES +HIDE_IN_BODY_DOCS = YES +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = YES +SORT_BY_SCOPE_NAME = YES +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = NO +GENERATE_BUGLIST = NO +GENERATE_DEPRECATEDLIST= NO +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = NO # Disabled for light doc +SHOW_DIRECTORIES = NO # Disabled for light doc +SHOW_FILES = NO # Disabled for light doc +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = @top_srcdir@/doc +FILE_PATTERNS = *.cc \ + *.hh \ + *.hxx \ + *.hcc +RECURSIVE = YES +EXCLUDE = @top_srcdir@/milena/ \ + @top_srcdir@/scribo/ +EXCLUDE_SYMLINKS = YES +EXCLUDE_PATTERNS = *spe.hh +EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::* +EXAMPLE_PATH = +EXAMPLE_PATTERNS = *.cc \ + *.cc.raw \ + *.txt +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +INPUT_ENCODING = ISO-8859-1 + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = NO +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = mln:: +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = @top_srcdir@/doc/header.html +HTML_FOOTER = @top_srcdir@/doc/footer.html +HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css +LAYOUT_FILE = @top_srcdir@/doc/DoxygenLayout.xml +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = YES +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \ + "for_all_2(x1, x2)=for(x1.start(), x2.start(); x1.is_valid(); x1.next(), x2.next())" \ + "for_all_3(x1, x2, x3)=for(x1.start(), x2.start(), x3.start(); x1.is_valid(); x1.next(), x2.next(), x3.next())" \ + "for_all_remaining(x)=if (! x.is_valid()) {} else while (x.next(), x.is_valid())" \ + "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret" \ + "mlc_equal(T1,T2)=mln::metal::equal<T1,T2>" \ + "mln_piter(T)=typename T::piter" \ + "mln_fwd_piter(T)=typename T::fwd_piter" \ + "mln_bkd_piter(T)=typename T::bkd_piter" \ + "mln_qiter(T)=typename T::qiter" \ + "mln_fwd_qiter(T)=typename T::fwd_qiter" \ + "mln_bkd_qiter(T)=typename T::bkd_qiter" \ + "mln_niter(T)=typename T::niter" \ + "mln_fwd_niter(T)=typename T::fwd_niter" \ + "mln_bkd_niter(T)=typename T::bkd_niter" \ + "mln_viter(T)=typename T::viter" \ + "mln_fwd_viter(T)=typename T::fwd_viter" \ + "mln_bkd_viter(T)=typename T::bkd_viter" \ + "mln_result(T)=typename T::result" \ + "mln_enc(T)=typename T::enc" \ + "mln_value(T)=typename T::value" \ + "mln_qlf_value(T)=typename T::qlf_value" \ + "mln_domain(T)=typename T::domain_t" \ + "mln_sum(T)=typename mln::value::props<T>::sum" \ + "mln_vset(T)=typename T::vset" \ + "mln_rvalue(T)=typename T::rvalue" \ + "mln_lvalue(T)=typename T::lvalue" \ + "mln_mesh(T)=typename T::mesh" \ + "mln_coord(T)=typename T::coord" \ + "mln_site(T)=typename T::site" \ + "mln_psite(T)=typename T::psite" \ + "mln_dpsite(T)=typename T::dpsite" \ + "mln_accu_with(A, T)=typename A::template with< T >::ret" \ + "mln_trait_op_div(L, R)=typename mln::trait::op::div< L , R >::ret" \ + "mln_trait_op_less(L, R)=typename mln::trait::op::less< L , R >::ret" \ + "mln_trait_op_minus(L, R)=typename mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_mod(L, R)=typename mln::trait::op::mod< L , R >::ret" \ + "mln_trait_op_plus(L, R)=typename mln::trait::op::plus< L , R >::ret" \ + "mln_trait_op_times(L, R)=typename mln::trait::op::times< L , R >::ret" \ + "mln_trait_op_uminus(T)=typename mln::trait::op::uminus< T >::ret" \ + "mln_ch_value(I, V)=typename mln::trait::ch_value< I, V >::ret" \ + "mlc_unqualif_(T)=mln::metal::unqualif<T>::ret" \ + "mln_piter_(T)=T::piter" \ + "mln_fwd_piter_(T)=T::fwd_piter" \ + "mln_bkd_piter_(T)=T::bkd_piter" \ + "mln_qiter_(T)=T::qiter" \ + "mln_fwd_qiter_(T)=T::fwd_qiter" \ + "mln_bkd_qiter_(T)=T::bkd_qiter" \ + "mln_niter_(T)=T::niter" \ + "mln_fwd_niter_(T)=T::fwd_niter" \ + "mln_bkd_niter_(T)=T::bkd_niter" \ + "mln_viter_(T)=T::viter" \ + "mln_fwd_viter_(T)=T::fwd_viter" \ + "mln_bkd_viter_(T)=T::bkd_viter" \ + "mln_result_(T)=T::result" \ + "mln_enc_(T)=T::enc" \ + "mln_value_(T)=T::value" \ + "mln_qlf_value_(T)=T::qlf_value" \ + "mln_domain_(T)=T::domain_t" \ + "mln_sum_(T)=mln::value::props<T>::sum" \ + "mln_vset_(T)=T::vset" \ + "mln_rvalue_(T)=T::rvalue" \ + "mln_lvalue_(T)=T::lvalue" \ + "mln_mesh_(T)=T::mesh" \ + "mln_coord_(T)=T::coord" \ + "mln_site_(T)=T::site" \ + "mln_psite_(T)=T::psite" \ + "mln_dpsite_(T)=T::dpsite" \ + "mln_accu_with_(A, T)=A::template with< T >::ret" \ + "mln_trait_op_plus_(L, R)=mln::trait::op::plus< L , R >::ret" \ + "mln_trait_op_minus_(L, R)=mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_times_(L, R)=mln::trait::op::times< L , R >::ret" \ + "mln_trait_op_div_(L, R)=mln::trait::op::div< L , R >::ret" \ + "mln_trait_op_mod_(L, R)=mln::trait::op::mod< L , R >::ret" \ + "mln_trait_op_uminus_(T)=mln::trait::op::uminus< T >::ret" \ + "mln_ch_value_(I, V)=typename mln::trait::ch_value< I, V >::ret" \ + "mln_ch_value(I, V)_=mln::trait::ch_value< I, V >::ret" \ + "mln_morpher_lvalue(I)=typename internal::morpher_lvalue_<I>::ret" \ + "mln_concrete(I)=typename mln::trait::concrete< I >::ret" \ + "mln_concrete_ch_value(I, V)=typename mln::trait::ch_value< typename mln::trait::concrete< I >::ret, V >::ret" \ + "mlc_const(T)=typename mln::metal::const_< T >::ret" \ + "mlc_const_return(T)=typename mln::metal::const_return_< T >::ret" \ + "mln_element(T)=typename T::element" \ + "mln_element_(T)=T::element" \ + "mln_delta(T)=typename T::delta" \ + "mln_delta_(T)=T::delta" \ + "mln_dpoint(T)=typename T::dpoint" \ + "mln_dpoint_(T)=T::dpoint" \ + "mln_point(T)=typename T::point" \ + "mln_point_(T)=T::point" \ + "mln_gradient_component(I)=typename mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret" \ + "mln_gradient(I)=mln::value::stack_image< I::point::dim, mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret >" \ + "mln_trait_value_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \ + "mln_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \ + "mln_deduce(T, A1, A2)=typename T::A1::A2" \ + "mln_graph_element(T)=typename T::graph_element" \ + "mln_graph_element_(T)=T::graph_element" \ + "mln_fun_vv2v(F, L, R)=mln::fun::vv2v::F< mln_value(L), mln_value(R) >" \ + "mln_fun_vv2v_result(F, L, R)=typename mln_fun_vv2v(F, L, R)::result" \ + "mln_ch_fun_vv2v(F, L, R)=typename mln::trait::ch_value< L, typename mln_fun_vv2v(F, L, R)::result >::ret" + + + + +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = @builddir@/../scribo/doc/scribo.tag=../../scribo/doc/user-refman/html \ + @builddir@/../milena/doc/milena.tag=../../milena/doc/user-refman/html +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = NO +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = NO +COLLABORATION_GRAPH = NO # Disabled for light doc +GROUP_GRAPHS = NO # Disabled for light doc +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = NO # Disabled for light doc +INCLUDED_BY_GRAPH = NO # Disabled for light doc +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = NO +DIRECTORY_GRAPH = NO # Disabled for light doc +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_DEPTH = 1000 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = NO # Disabled for light doc +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO + + +# Local Variables: +# mode: Makefile +# End: diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml new file mode 100644 index 0000000..a279910 --- /dev/null +++ b/doc/DoxygenLayout.xml @@ -0,0 +1,184 @@ +<doxygenlayout version="1.0"> + <!-- Navigation index tabs for HTML output --> + <navindex> + <tab type="mainpage" visible="yes" title="Home"/> + <tab type="pages" visible="no" title=""/> + <tab type="modules" visible="no" title=""/> + <tab type="namespaces" visible="no" title=""> + <tab type="namespaces" visible="no" title=""/> + <tab type="namespacemembers" visible="no" title=""/> + </tab> + <tab type="classes" visible="no" title=""> + <tab type="classes" visible="no" title=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="no" title=""/> + <tab type="classmembers" visible="no" title=""/> + </tab> + <tab type="files" visible="no" title=""> + <tab type="files" visible="no" title=""/> + <tab type="globals" visible="no" title=""/> + </tab> + <tab type="dirs" visible="no" title=""/> + <tab type="examples" visible="no" title=""/> + </navindex> + + <!-- Layout definition for a class page --> + <class> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <allmemberslink visible="yes"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + + <!-- Layout definition for a namespace page --> + <namespace> + <briefdescription visible="yes"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + + <!-- Layout definition for a file page --> + <file> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + </file> + + <!-- Layout definition for a group page --> + <group> + <briefdescription visible="yes"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <dirs visible="yes" title=""/> + <nestedgroups visible="yes" title=""/> + <files visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <pagedocs/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + + <!-- Layout definition for a directory page --> + <directory> + <briefdescription visible="yes"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + </directory> +</doxygenlayout> diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..ac2fd2e --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,155 @@ +# Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development +# Laboratory (LRDE). +# +# This file is part of Olena. +# +# Olena is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, version 2 of the License. +# +# Olena is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Olena. If not, see <http://www.gnu.org/licenses/>. + + +# Look for Milena headers in srcdir and for (generated) test headers +# (like data.hh) in builddir. +AM_CPPFLAGS = -I$(top_srcdir)/milena -I$(top_builddir)/milena + +DOXYGEN = doxygen + +DOXYFILE = Doxyfile + + +## --------------------- ## +## LaTeX configuration. ## +## --------------------- ## + +include $(top_srcdir)/build-aux/tex.mk + +TEXI2DVI_FLAGS += \ + -I $(srcdir) -I $(srcdir)/outputs -I $(srcdir)/outputs/split \ + -I $(srcdir)/img -I $(srcdir)/examples/split + +# Additional files for LaTeX compilations. +DOC_PACKAGES = doxyfuns.sty milena.sty + + +# ----------------------- # +# User Reference Manual. # +# ----------------------- # + +all-local: $(srcdir)/$(USER_REFMAN) + +# Run "make regen-doc" to forcefully rebuild the Doxygen documentation. +.PHONY: regen-doc +regen-doc: + rm -f $(srcdir)/user-refman.stamp + $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/user-refman.stamp + +DOXYFILE_USER = Doxyfile_user + +REFMAN_deps = $(srcdir)/footer.html \ + $(srcdir)/header.html \ + $(srcdir)/doxygen.css \ + $(srcdir)/mainpage.hh \ + $(srcdir)/DoxygenLayout.xml + +# Sed is used to generate Doxyfile from Doxyfile.in instead of +# configure, because the former is way faster than the latter. +# +## FIXME: This is because, as in TC, we depend on $Id$ from the +## ChangeLog. Maybe we should depend from something less prone to +## change. See Bison's build system. +edit = sed -e "s|@ID@|$$Id|" \ + -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \ + -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \ + -e 's,@top_srcdir\@,$(top_srcdir),g' \ + -e 's,@top_builddir\@,$(top_builddir),g' \ + -e 's,@srcdir\@,$(srcdir),g' \ + -e 's,@builddir\@,$(builddir),g' + +$(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in + Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@ +MAINTAINERCLEANFILES = $(DOXYFILE_USER) + +USER_REFMAN = user-refman + + +# HTML. +EXTRA_DIST = $(srcdir)/user-refman.stamp +MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp +$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) + @rm -f $@.tmp + @touch $@.tmp + rm -rf $(USER_REFMAN).tmp + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER) + $(DOXYGEN) $(DOXYFILE_USER) + rm -rf $(srcdir)/$(USER_REFMAN) +## FIXME: Moving directories between file systems is not portable. + mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + @mv -f $@.tmp $@ + +$(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +# Installing a directory located in the source dir is not supported by +# Automake by default, so we cannot simply add `$(USER_REFMAN)/html' +# to `dist_doc_DATA'. The rule `install-data-local' (see below) used +# to work around this limitation is borrowed from the Vaucanson +# project. +EXTRA_DIST += $(USER_REFMAN) + + + + + +## ---------- ## +## Cleaning. ## +## ---------- ## + +MAINTAINERCLEANFILES += $(dist_pdf_DATA) + +maintainer-clean-local: + -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) + -for d in $(DATA_html_dirs); do \ + rm -rf $$d.tmp $(srcdir)/$$d; \ + done + + +## -------------- ## +## Installation. ## +## -------------- ## + + +# We install by hand, otherwise Automake produces "install .../srcdoc +# .../srcdoc", which installs our dir into the previous one, instead +# of replacing it. +install-data-local: + $(mkdir_p) $(DESTDIR)$(htmldir) +# The user reference manual is located in a subdirectory, hence this +# special case. + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) + cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) +## Try GNU chmod's X mode before resorting to something slower but +## more standard. + chmod -R a+rX $(DESTDIR)$(htmldir) || \ + find $(DESTDIR)$(htmldir) \( -type d -a -exec chmod a+rx {} \; \) \ + -o -exec chmod a+r {} \; + +uninstall-local: +# Same remark as above regarding the special case of the user +# reference manual. + chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) diff --git a/doc/doxygen.css b/doc/doxygen.css new file mode 100644 index 0000000..104c7dd --- /dev/null +++ b/doc/doxygen.css @@ -0,0 +1,856 @@ +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + font-size: 150%; +} + +.title { + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #9CAFD4; + color: #ffffff; + border: 1px double #869DCA; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { + color: #4665A2; +} + +a.codeRef { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 10px; + margin-right: 5px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #C4CFE5; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; +} + +.memname { + white-space: nowrap; + font-weight: bold; + margin-left: 6px; +} + +.memproto { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 8px; + border-top-left-radius: 8px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 8px; + -moz-border-radius-topleft: 8px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 8px; + -webkit-border-top-left-radius: 8px; + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + +} + +.memdoc { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 2px 5px; + background-color: #FBFCFD; + border-top-width: 0; + /* opera specific markup */ + border-bottom-left-radius: 8px; + border-bottom-right-radius: 8px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7); + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7)); +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +.params, .retval, .exception, .tparams { + border-spacing: 6px 2px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + + + + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0px; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; + margin: 5px; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable { + border-collapse:collapse; + /* new */ + width:80%; + table-layout:fixed; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; + + /* Changed */ + text-align:center; +} + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + font-size: 8pt; + padding-left: 5px; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +dl +{ + padding: 0 0 0 10px; +} + +dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug +{ + border-left:4px solid; + padding: 0 0 0 6px; +} + +dl.note +{ + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + border-color: #00D000; +} + +dl.deprecated +{ + border-color: #505050; +} + +dl.todo +{ + border-color: #00C0E0; +} + +dl.test +{ + border-color: #3030E0; +} + +dl.bug +{ + border-color: #C08050; +} + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectname +{ + /* Changed */ + font: 32px Tahoma, Arial,sans-serif; + + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + /* Changed */ + font: 13px Tahoma, Arial,sans-serif; + + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + + +/* ===> NEW */ + +table.itable th +{ + font-size: 17px; +} + +table.itable li +{ + font-size: 16px; +} \ No newline at end of file diff --git a/doc/footer.html b/doc/footer.html new file mode 100644 index 0000000..d0e98ec --- /dev/null +++ b/doc/footer.html @@ -0,0 +1,5 @@ +<hr class="footer"/><address class="footer"><small> +<span style="position:absolute;text-align:left;">Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE)</span><span align='right'>Olena 2.0</span> +</small></address> +</body> +</html> diff --git a/doc/header.html b/doc/header.html new file mode 100644 index 0000000..a94502d --- /dev/null +++ b/doc/header.html @@ -0,0 +1,46 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>$title</title> +<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/> +<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css" /> +$treeview +$search +$mathjax +</head> +<body> +<div id="top"><!-- do not remove this div! --> +<!--BEGIN TITLEAREA--> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <!--BEGIN PROJECT_LOGO--> + <td id="projectlogo"><a href="$relpath$index.html"><img alt="Logo" src="$relpath$$projectlogo"></a></td> + <!--END PROJECT_LOGO--> + <!--BEGIN PROJECT_NAME--> + <td style="padding-left: 0.5em;"> + <div id="projectname">Olena + <!--BEGIN PROJECT_NUMBER--><!-- &#160;<span id="projectnumber">$projectnumber</span> --><!--END PROJECT_NUMBER--> + </div> + <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF--> + </td> + <!--END PROJECT_NAME--> + <!--BEGIN !PROJECT_NAME--> + <!--BEGIN PROJECT_BRIEF--> + <td style="padding-left: 0.5em;"> + <div id="projectbrief">$projectbrief</div> + </td> + <!--END PROJECT_BRIEF--> + <!--END !PROJECT_NAME--> + <!--BEGIN DISABLE_INDEX--> + <!--BEGIN SEARCHENGINE--> + <td>$searchbox</td> + <!--END SEARCHENGINE--> + <!--END DISABLE_INDEX--> + </tr> + </tbody> +</table> +</div> +<!--END TITLEAREA--> diff --git a/doc/logo.jpg b/doc/logo.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a68a505583cdf475c11054066db4ded69dafd17a GIT binary patch literal 7477 zcmbW42Q-}9x4^%dF?t)l8@<;cqxVj9qL(okz4wxcNQ^Eadaoe_K_q%7f(U{jBm{{> zi5e1b-1~p`-uKpeW&QW8b<S`0*?XV;?Q_0wopU*VxeAc$XlQEyAgl<21Oec34JcO+ zMY{lizCOSY002G!1yKMHEP=2;0K@=5|6l;n0Wto?#vtB**?<Ay9vZ;;myH#+zd~%} zKfM3!p=khsht=SSii?RB|0j!yiWY<Zo~ao8SCs3;kiQx02V8z6zNxLMYHw(4prNg& zj!ho`h_&?4-acS*0Pyk-^f%U2f#0;Wg5ym9V1NL?1;hZr5gFjCZ=zv(6+v5F6&`>! zy5fHcHpcPXRh9toR!GYb4*!?_|J%WkzW#yO$27z`TysVRAh8^WWzUd6-z)tdmZ_XP zt{8k(A1Z%rf>@@zV%I<Usy<Xsf3ngQJ9~LMV{NW-_I37hzTyEa-wzH#VHu)_<@jJU zDg?_jSmyK$@<L<z6w6dzD8~S7k%_PLfheTgRl%`L>~CtUie)+M;u5?5gPs1tfv8Yy zo&ccg;~VCWc6AGc^CJ1+V$#wGxE3nJ6BQUJWax<WaP)VEtNM8PI(mlzz@N{2<poe& z)fSE|vXq##l$4OTFt+@E$^Sa|m(~9cS8MyH#Sf!D)(k{5{<rRL-@kP}r2v39!qz73 zZ=F*P0JPl&0J_D$b)3ZjKo$o8t&{(F9-6ED;uaX_D<dKj5)vYeMj?f-3i_A)p9X(f z{?G7_`Gl|L`>S?vHI$2EkY^zLs;EdGPoE%vcz~}X5(O9f@0<AFcKk<L|Hwno80CWU zM|oqXGRN*Rw6`mExxJmyfoLCZINJMvTH$}w?H@T@;h*~&3zX%*0V;c8fP9h)fP5PV za43lYh)p4O1oYRs=@FO%S8tvL>*k;P9?RJAKidD&fK#!5!2xJj_?24K*c6To@(;dZ z>^pJQKmkI444?w&0TzG*;01&Lao{>23n&5VfDT{)m;#o79e@Pf058BF2mvC2+dw>! z2&4g-KrT=Olmj(DJ<tTS0UbauFa*2;rhr-CJ+KOF0AGPU;21c^er@qUBp^x<J%|;= z1rh*>gAgDEkUB^YWDK$dIe=V2-k=~*B<Kz(5tISS1(kqmK#ibwP%mf{^aiv5S_5r^ z4nRM_5HK;A3d{`V28)0ZU}dl_*c5CFb_M%^!@+Uj6mT}U6kG>x1^0qqfoH+1;IH5# z2mm31&_LKALJ$N*6=DFfg1A8ZA<+;FBnwgssfWCP3`5>RRv|l(GaOtTN*p+j5RNR4 z7LFMX62}iG8Yc-S7pEGh6=wkFEzTOw9?owl36u#c0F{AiLvKP|p&`(CXcn{*+5#Pf z&O$e!$GEt-G`Kvt*KxIQEpgp(BXE;&3ve57dvM?2e!@M%!^5M;6Tp+lGr)7i3&e}Z z%fYL|>&BbL+rT@;C&FjN7suDYx5D?vkHycze~jOSKaIbMe@;M7z(pWKU_jtZ5Jr$n zP)_iIV3J^i;G7Uf$U`VkXiDf#c$+Yru%2*`aEb5-5fKqPku;GJ5t`^0Q8v+2q7kAs zqBCL&Vt!&(VjJQh;uPX4;vV7!;vXa=B-|uQBvvGWBq<~{B>f~SB&Vd5q{5`yq|T%< zq<N&Rq|>C|$q2}}$dt+K$im68$ePI}$#%#I$hpZ?$sNg~$@9qD$={J5!6;#3Fawwu zED81)HVWIKz@y-%P^WOFh@&W@=%@HZ38CbmRHZ~x-k~g~9HiW!!lmM&(x!5!N~C&1 zH9@sUO+hU|ZB89Zok!hCy-EY2;il21@uW$mX`-2<`AN%6t4xccO`xr(ou)mZW294} zL(yUA8t7)}e$vC~)#*Lx)9Ksjml<#v_!*2CLKq4e1{ro3sTgG$k&GC|CdNf3FcUwM zF;fIn8Phn^5i<+3CbKVd4s$>A4hs#75{o;_LzXU<ZB|NF1y(fcL)LEAFK}wOGTalM z4IhB-u`#h}u?4Y}uuZU?v-7Z<vB$DEurG5Eav(TdI39BJaqMxja_VzNa@KM#auIML zxZJoNaSd~waPx3maNpx@<KE(-<I&~`=c(mc;w9l#<n`k%<(=Wf<wNj!@D=b)@q_s# z`Q7;Q_$LLx0#X8KfdYXyf>1$eL2toQ!FNK$LdrtHLbXC`!ZgBq!m+|_!rw(WMXW^9 zMTSLwi%N=mik6GM7o!l<5sMXjA$B0nFOC$?6Q8+8a!un}%(ds&_9X-)P!fd_^OBU3 z`jYn~`y_u!U6=Bgs+Zcn&UxM8dj9oy2r7gjA_*}f4V6}rj*;$=K9iA>36yD)*_9QN z^^komyCugXhmtFo`y|gU?<ij)zp4ONa8M{#SXE?GbW|)={HVmC<g8Sww5iOe?5<p= z{9Q#<#b2dG<wR9RHA=Nd4Wg#0hEbbPr%*Rj&sAU1VApWfsMXlhl+=vS?9qa1>1w5G zz0+paMrzk+@9A9EiP9O+CDt|3&DH&=$FJwF_d*}6ucQA!f9VF-4euLm27rOK!2^S3 zLmopv!<R<5MutXtMxTwvj3bSQO(;$5O&*&Zo2r<mn!Y#VH48H9Gbb~*F|RQ{u~4(f zuvon*ax?1YD@z7TwB>UvJS%gnN~<Glb?Z#)4I4?Dc$+y}9@|jcQ9A}ZPrFWgGJ8k+ zW(TN)g~MZq3r7RTQpY1FZKr&vJ)|n~5%R0ElJi67ZInDJ1GVWQ?~>uN<tp#`z;)YA z(Jjku2d#?EMen<7xfi*gco=w8d0cv0cs6+9dpUTudsBFOcn|on_=Nhr@fGlm_g(dq z@yqnv^VjvS3;+e#20Ra>!XBo^gLs4P2CW4v1m^{xhM0#mhr&X=L&wAT!xF+a!!^Py zB5)#*5q*(tk+&n)qLiabqCwG4(S0!-F>x^)w={26-zL26ar<?wXlzF8;T?-RFXEWv zZpD4Nt9iFJo;2P+{@p#<dqwwg?xXKdBwS0#N%)O%#*8J3CT1mGBq5W=lEsp<lP^<T zQYKQRQVY{?)4bE>(iPLIGhi9v8J`~LKWKdje~5W_m}#FmnkA7{^oa0L(4*CCz3k^X zoH=PZ7rAb^vw13c4f#y@3Hc`l&IQwjN`>`B%teVsKa0`D^Cg-kt)<+hS!K9o!DXMz z&C7=?5EV6*43&wMzpA{eR;!Jx2Wqa@)I4T-oLUR64XWL)v#FbUqW0u@y-<Bg15HEX zQ{ZXP(=Uw<jdM-9O?}OX=K5z`&+=O+TQIGl*09#SHn+Cb=a$dkwCl9@y^wv;@>2L^ zRR>!~UMF>DY8PQwT-RlHc=u6{Z_iGzYwxE%`@Z-6H~VJ>j0PqKbq7a=G=}<zm4~}W z<VQM2Wk%b_5Mynxq+Yd-OOCg^mVDhZAvMuDd42Nvl=Re#H*#;frWL1q->SVGn$ezl zHG5<B&79fX{5zX>tMktDTMM2G`-{Pg=kISVL6<Pg<jYwrOe>`y_&zkOO09OTsjZEF zH2L`c6Y|s7^?>z@jkwPwpR+buH*2=Uw>q{pwx_;Wf7$rz`}KS${u}ID{&(K*&vun| z$M<gTZS4E+Umhg=p#M>IC~??#WO%f4>~(y8f;pu>tv*AX4ga+Gxp^LPfp?Mpi|^Nq z-@3n-F1;=<FW&>If82(yZbbjCTm|`eegE>i>;Yi-*n`J)2#6g3!$1%i=yCvH#GYxO zSJ$1t1s4yWfDnp<9pop!8U#Q%V60qS*#I067y`u_05A$l0xD`Y8ZmZGLJsk(Kp+5X z^Upv~JTNW@f`1i=2Zp_eVPk-BAlQ7a0%7CeKw%WPlmHbQI|rVavN$!@<sv|gjR1y0 zV1Od<&ig?bYO;Cpz-I7ih5LSvl5mJ`%0@(u>U6UE!=uTZ#BbD@4+M1im5mtT4pQ`0 z8Xar7EqB)z%xeqdku)KQZ+vT-WJ8*DPcW1f$!Zz`OPWh(jv5z6QDrHb{F3RNH-Ch_ zo2;sw4T;!V^2^GL{K@JU;i5X$*wTFG?DVtX$MQ?yy+ryLvJkWDbB9xFeom~;r`$EJ zFMlGY<0=00vDVLKfw;<$m2{0>&(SGWKR4OTXrrnn@_u@8{$HZSugy|-BQi<PBwx*c z^|#XyE_1Gda>e%3-G~#Bmo3s;c%LHwP;t6}IeY{;Ja`c?-q`3SC4PH9z$Ul4s7*lL zGwC}bKtiu0T^bywRSbQV<x=2h{vl4llc4mO!<0xzvz#VJi9w*j8K?W1Vv9eARkDA3 z)Z+d6-<?6~jpb7sCN`%0`>=1Eu8~$Zr#Yyd&`9k)xP{i~@=^JI^Nvs3Ak+QCudgS= zZIkmk<~=?Ladh4IEu3{Te=_*`ia4qKI`3r0Ak!!Z68|{9y)K+nB=bYS%SzguEidk7 zT3zZpm%#UlP5_NZ*!37~*ZtfxIAdIpA(#|tCZw7*Ww4xVHx-kXB0Wts&}o+=GavjS zzEJXA;?!OTuNv3cc}h>o_Iw0ktWIss(~g=;V0wt|f?Cl8V_j~Px-l;cQ|aEytJ!>R zxKk`1-ew(=u>W(?E8`dElrh1{JJJ1hIC%Y0kcE+G7P+b*<%C3Et}2W@Cu2}{UQOUw z(&|vS&16t6ua^}y%m3-KRivcpapl(!f+otTMk;Av!9z2GuvzP=#`LH;3G*hLNIxwZ zYAgDKR1QwkfNY1aV*8)2|Dw~?F<H-2pLj<Nwf1t(Sc)hr)@Czzo48Fv19l`1vYekQ ztB9CiS1Y{)E|O$ZBBVd@P+z!(jtKew`Y~Q#kWf>y*)E-D>t*nIyWXKuRyPK?fxbQG z<^!oO^}NTk?91p=POq0z{`s1>a08EQrLcM<&#n39LUYM6=cf(uU#gt%4>_lDB|Arz z9td*H3sKO$@6hp@Z7~`zT+Dlk`sm|y)Q<?CBluPTyKVCjpWjaM(GB#Q>XF0bYlBOX zl?Ox<E8CT;_Njui<8<SC$KrNDp1udOZf&B*)Dpg1mEBK~7DNx8i3W>jloGIYc39Nv z%P85Ic^Ft+0)3G#8y`~ZdG3EgXuM58UN~?cej6a56p>+7Qg-qhTrPQ>%<fylX2S)4 zbwmiYQB^_o*A}ssO?iX`-_bUobH8xajI=Sw7Y{}RjEs*JZ+~E~AAo(k(5YHt-@}94 zCA+`=?HHD2vXgMk`*pWPH;xzqGH<rzIhoVKP{rI%U==JHsNJ-h-6i9S*-<vAX3_d^ z5Z>v;cR)I0W@g|Mm*UQI{yUxFe&V+;oPH7K3TE-owlg_@r4p+O)Nie4J37q8qMni1 z)KqH@CcC7(=`~e)5~)ULGxZv$x|?@pH&iBUG-o-TkM-%<>!yJG<91_Z&YbGqdoRsk zO|_Y0nCc={A0Ho-TD<Lz`sv5f*R$)U3QRQ~1PDDqLtoZ3aPP4ZXZ0T~GG+Q(lWCn0 zPaYJ2?agOq?vaGQ(yR~<OcGNNA^08~Et#6GOprC|ZkcK>I2muOGuD5+q+g!TqE83Z zX_>69JpS6$aZaT#&K0rk<aaZGzkID=L8q{e#><r7^qjWZne7%Ex2x^;@36Bx^jPS! z%KCxaPy~MK;w!pxkDM|~2D;f<j(I8cz~gHB#r&dA?8LP%14>W{e0H1=p<~w$pUq6q z$pGd{;HL1fk>8DN-mueUsGsJ7#arBz=E8eI%C1I!9#%|7G6AT9)-N0!kq<H%6$Y*1 z_EmG{PCY)e25b~<wlZHwRgzYPJ>w?MKcuqh`*_&@`M!fsN?Tg8meqUBd3IWATfef_ zu9DCAa>g3GKN=iA;*ot<u-s2Y94)Ihs<yAyb;w>DU3gRSWVPw5_rB_nbNQnc#nVSt zy5%;$W;46LY~`cq{mh7j3Zyd>dT%)1{1R-Pw3N#(w=bXD8A)^;_tekbBGrOTp^SU* zK%C{iH&Hpduh+=*{SHZ2H^gRf@X=d4-SCaN%?G~6D6!8KZu@2!Jb1V#eYTi73RL%F zQ^NI5m%s^`=!HSeXnNyj=sDtvmzA6>s8TBx<!OF*kQvk3w}?5=>S@lHcAC=C;rt4! z@bcW#&sXeGgnYF#4%+34;ZxB5vMV#GRKfl#_s6o`)J*Gh#RxAwq58Lm*HFip`fk<~ z@n%J3`<rw@RNIe}+<5_)s4~r3mgR{H%gJa&$H^x-Rb^c#=9APeL+`-D`t3G(Sxwxo z-A7xmGiG9sa-)P!rvNWoD-%=E5p?xnJ#K5UC^#0jxNsV<_D*8|QNK6Wr#QqHMn<Mb z5)57oCJ>zRtrzA`wVy?i4j~Kn_$*ORT3c>W86%a@pX%#id-1@&`b!>0O3Nn`SzQ5{ zt&<W##Le2JB{a?iQoKjs#5DMO`+mD-n(WzC1)enqFK`qj`DYnqJtebR>qV(qKPn#t zVtNgY$g7QMbBZu2?b#xds(BM18QCqP(`dpIL-cx=9FNzA-TOp5kp}aY+(}uQHy~y^ zaay^jpXgjQ87KAb*}QD(T6aWkd(sdxY~a8=OF2h_A_OpbpamZ}vOtI>wW`)hbcS`| z6ZX+Q%zT;QpktP1dEq$^C8NXJtTI%iz0GJBb#Ca0Cc(B+o$MiD-Rx?FZVLdq_i8v5 z?SJj)5-{`)xK_~QDeyqfCQo3dNjBwxS(UHET=kXSZ=By8@!kE*c{gv2P<i&N{8(TU z?fk$yrJdrDz8`T3JX6z@{5^8Nh!s=S-S!exJm9q*S>3cHYvY7gc`>mYz?2;(A>rB9 z0OEb3QTcRm1Gkyq!@)g(uRb_S_kMLeX48cF)?4}@E_ILRim8b?f_2Y^^7uQOWUQvG zISRYQW)gC)&2O?_xM0-I%4QXR{$8rx-Ti_-uJNYLcM#<Nc$ctr2cg)s(i$9-4$HwD z?X*<ZCOc#f893h1&sG=A5GTB?#i4tR%00H~R?+^<TiK|`db#Utb6#AQoVG9lBPlhT zTSke<;I?RtQO;+CcX-jG$@L58tl)PXtas!_oEFZ-aB7{>$lxiq;3J=IZl7Vf5Jh&y z+gvMnRlA4Q%TbjBqdxw$>L09o9fDetgEE<#lDvX5hD;1%i$%*~hjP<$im3H(iC~_f z98K6I6f-9IUrgR-v;%d|{D^AM+_!3WEq?Z$eGQs11evT&m1UJj&H7IB)n-b^dwxHJ zk4rquU@j<*9Sb3JhY0%7j^4kp`Qd>a8*hSl_~=fpxT<8=EV$UoyyB2=T<xQ89HjT2 ztesg~<ckR`eLm84!?(MJ)2A&zimof+<98mvOvHn}je@i#jmmP^CcK5r_7VRiNx1zi zQ;N>w*qZmXR}v}yh&W@{2wSF9<h9oVmq7AHaG2vb=HswWLegU{ra}~ALxkc+jaoxw zEV#}5*MMk=ee97;%kpXKFhl$9y~L-^?@*t6T^1P5&Cz+ZrY@#L**tQ(yn)w~7X`GR zT3CHMFysENm_IrEzC&sIuwnmXv`&H6I+B*_1ukJ8sYifi@uPOf5J^*W69TGZy1l@_ zxrg^=fihhQ=TUHhHC6u(vfT5|go+xMo*wb@pn0Pa-i?XVp0Ww6t?x)?2*xrdgTJu2 z=ZhoKTzfJ<l>HLOdovnW)Z0@LXg?mt(4z%TTH@wu+SL#olYZiX%Mb6_JkXYO3qITC ze0W>pM?Xcy9fo%XeD-=DtjgK~94n^Cj7{p${vn3qmRd<aUsA-%zimnJaK+TGw0|Vv z>77tJb#sY;jm>0QbuV=kcAAiS+EKT@2s8asxU1g;;#Si;x1K98?bfc1TF~OWYw8%f zHPh0vH%9;A>AhN!Hx#=XHx6`VM?lhAcj?JYlzu&`GIn%Bm$&U7Cchq}n*SB~vX&u& zcs6yr@2B2;9L^5P#*0O>hj(aG2Tx^cTAeG7o}X!mnkjuKJoIkDvMX#RKosJ5!^{%# zi&#yNU6(zFq+_N^n<~A=A#KzAkvY!`>4R4MOr|+0giTe&X>ZvlhkT8SN--Ei#m`PJ z{^^h>nnvdyX6`0Cpb&2W@7weWv~AX1;@#Y4tDHz;Q@5pD=GZVhU6{XFpu8ou&#dAU zV5bFKOcup<X_^wpDE(?nV<)Va;(m%=cOBHt+d0-kh8#X|Zx|fGJl^$*Ir;i-HgbJ( zW$SENHlZmOlav@y>am6y3FV>~`ysFIYxMD#sKh8|amK`poGEJhmhy?17txsyx5c)O ziavUp`m9H`pA@HvRBV!)%)O3Mu$GQCZ2$75{;sX%O|Uj3^^V+2jxQJ1%Ma-0&XOf6 zm8qzelXD2FYM)Tk=DgHD=K#kY5k_AE>>-(HGAFN_f0`-}nybGK&3oKN#?MF9%7CwY zT^rC>`-Qesk9wb>O~w%V8TOcowceRMk7WH6G~`LVA5)E%#O;Z;f9U}ooSV@E4zfui zcDObjmN?_e)017Mza9CHr9|YGNY#Fv-|&lZ+&UciQN#AbS8IKEsBy(JW;-IbLN*3P z8_!>!#?Zo3xQQ96c+c9u@5(VN-u83bGJ0K<4@0y+$<o(Jxo`>CB3bZx$;LlN)1F4n z;T<S$#G7{)ySqO*BQ?=YLTv=D4kP_24iWsiLH%}ON;H`E&m&6v18*w0zGvW-^9~%< z*=oFRapGMSCemA(C|W(^^p0)JoTCt9-q%nF4+AG~K3Ir0K{y#p{{CGfKP%6YYDOj# zo;+kysi9UV(}`A<MX*N7xwE|G96bwfm#>WJPV2eJH2TqklH&Ae!AQrRnfD9xbA^|C z;*<@?ot}W=+8LG1C6LW9{^9;{0TBl#FYDV$r;0*^EMqalVe##;#UhlKJHc#Y50&qt zr7OjA#}VxW2Y$6CO-NPho2|p}z!(<ymK-~2nf0%G-#5AQB^@5}K4EgtDe)aNlzj<Z v|E)K!?PR_BtqNhOFXvh+L^XQ}ATuU-_ldQ=!zh!|Vs0BLtpW-$mka*^gSw+k literal 0 HcmV?d00001 diff --git a/doc/mainpage.hh b/doc/mainpage.hh new file mode 100644 index 0000000..0704753 --- /dev/null +++ b/doc/mainpage.hh @@ -0,0 +1,38 @@ +/** \mainpage Documentation of Olena + + <center> + <h1>Olena Reference Documentation</h1> + + <table class="doxtable itable"> + + <tr> + <th>General Presentation</th> + <th>Modules</th> + <th>Applications</th> + </tr> + <tr> + <td><ul><li>What is Olena ?</li><li>Bibliography</li><li>Contributors</li></ul></td> + <td><ul><li>List of Available modules</li><li><a href='../../../milena/doc/user-refman/html/index.html'>Milena</a></li><li><a href='../../../scribo/doc/user-refman/html/index.html'>Scribo</a></li><li>Swilena</li></ul></td> + <td><ul><li>Online Demos</li><li>Papers Related Programs</li><li>Olena Powered Programs</li></ul></td> + </tr> + + + <tr> + <th>Contributing</th> + <th>Licensing</th> + <th>&nbsp;</th> + </tr> + <tr> + <td><ul><li>Report Bugs and Make Suggestions</li><li>Get the Sources</li><li>Online Resources</li></ul></td> + <td><ul><li>GNU GPL</li><li>Commercial Use</li></ul></td> + <td>&nbsp;</td> + </tr> + + </table> + + </center> + + <br> + */ + + diff --git a/doc/olena.qhcp b/doc/olena.qhcp new file mode 100644 index 0000000..595d34e --- /dev/null +++ b/doc/olena.qhcp @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QHelpCollectionProject version="1.0"> + <assistant> + <startPage>qthelp://fr.epita.lrde.olena/milena-2.0/index.html</startPage> + </assistant> + <docFiles> + <register> + <file>../milena/doc/user-refman/html/milena.qch</file> + <file>../scribo/doc/user-refman/html/scribo.qch</file> + </register> + </docFiles> +</QHelpCollectionProject> \ No newline at end of file diff --git a/doc/subdoc_footer.html b/doc/subdoc_footer.html new file mode 100644 index 0000000..3548c1e --- /dev/null +++ b/doc/subdoc_footer.html @@ -0,0 +1,6 @@ +<hr class="footer"/><address class="footer"><small> +<span style="position:absolute;bottom:0;left:5px;text-align:left;">Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE)</span> +<span style="position:absolute;bottom:0;right:5px;text-align:right;">Olena 2.0</span> +</small></address> +</body> +</html> diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 843280a..494d99c 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -1,5 +1,5 @@ -# Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development -# Laboratory (LRDE) +# Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and +# Development Laboratory (LRDE) # # This file is part of Olena. # @@ -20,8 +20,10 @@ #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = "Milena (@PACKAGE_NAME@)" -PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@ @ID@" +PROJECT_NAME = "Milena" +PROJECT_NUMBER = "@PACKAGE_VERSION@" +PROJECT_BRIEF = "An Image Processing Platform" +PROJECT_LOGO = @top_srcdir@/doc/logo.jpg OUTPUT_DIRECTORY = @builddir@/user-refman.tmp CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English @@ -54,8 +56,8 @@ EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO -HIDE_UNDOC_MEMBERS = YES -HIDE_UNDOC_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = YES HIDE_IN_BODY_DOCS = YES INTERNAL_DOCS = NO @@ -144,9 +146,10 @@ IGNORE_PREFIX = mln:: GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = +HTML_HEADER = @top_srcdir@/doc/header.html +HTML_FOOTER = @top_srcdir@/doc/subdoc_footer.html +HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css +LAYOUT_FILE = @top_srcdir@/doc/DoxygenLayout.xml HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO CHM_FILE = @@ -327,26 +330,26 @@ SKIP_FUNCTION_MACROS = YES # Configuration::additions related to external references #--------------------------------------------------------------------------- TAGFILES = -GENERATE_TAGFILE = +GENERATE_TAGFILE = milena.tag ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -HIDE_UNDOC_RELATIONS = YES +CLASS_DIAGRAMS = NO +HIDE_UNDOC_RELATIONS = NO HAVE_DOT = YES -CLASS_GRAPH = YES +CLASS_GRAPH = NO COLLABORATION_GRAPH = NO # Disabled for light doc GROUP_GRAPHS = NO # Disabled for light doc UML_LOOK = NO -TEMPLATE_RELATIONS = YES +TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = NO # Disabled for light doc INCLUDED_BY_GRAPH = NO # Disabled for light doc CALL_GRAPH = NO CALLER_GRAPH = NO -GRAPHICAL_HIERARCHY = YES +GRAPHICAL_HIERARCHY = NO DIRECTORY_GRAPH = NO # Disabled for light doc DOT_IMAGE_FORMAT = png DOT_PATH = @@ -360,6 +363,15 @@ DOT_CLEANUP = YES # Configuration::additions related to the search engine #--------------------------------------------------------------------------- SEARCHENGINE = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the Qt help engine +#--------------------------------------------------------------------------- +GENERATE_QHP = yes +QHP_NAMESPACE = "fr.epita.lrde.olena.scribo" +QHP_VIRTUAL_FOLDER = "scribo-2.0" +QCH_FILE = "@builddir@/scribo.qch" +QHG_LOCATION = "qhelpgenerator" + # Local Variables: # mode: Makefile diff --git a/milena/doc/DoxygenLayout.xml b/milena/doc/DoxygenLayout.xml new file mode 100644 index 0000000..ff1e5e4 --- /dev/null +++ b/milena/doc/DoxygenLayout.xml @@ -0,0 +1,184 @@ +<doxygenlayout version="1.0"> + <!-- Navigation index tabs for HTML output --> + <navindex> + <tab type="mainpage" visible="yes" title="Milena"/> + <tab type="pages" visible="yes" title=""/> + <tab type="modules" visible="yes" title=""/> + <tab type="namespaces" visible="yes" title=""> + <tab type="namespaces" visible="yes" title=""/> + <tab type="namespacemembers" visible="yes" title=""/> + </tab> + <tab type="classes" visible="yes" title=""> + <tab type="classes" visible="yes" title=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="yes" title=""/> + <tab type="classmembers" visible="yes" title=""/> + </tab> + <tab type="files" visible="yes" title=""> + <tab type="files" visible="yes" title=""/> + <tab type="globals" visible="yes" title=""/> + </tab> + <tab type="dirs" visible="yes" title=""/> + <tab type="examples" visible="yes" title=""/> + </navindex> + + <!-- Layout definition for a class page --> + <class> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <allmemberslink visible="yes"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + + <!-- Layout definition for a namespace page --> + <namespace> + <briefdescription visible="yes"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + + <!-- Layout definition for a file page --> + <file> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + </file> + + <!-- Layout definition for a group page --> + <group> + <briefdescription visible="yes"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <dirs visible="yes" title=""/> + <nestedgroups visible="yes" title=""/> + <files visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <pagedocs/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + + <!-- Layout definition for a directory page --> + <directory> + <briefdescription visible="yes"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + </directory> +</doxygenlayout> diff --git a/milena/doc/milena.qhcp b/milena/doc/milena.qhcp new file mode 100644 index 0000000..1a4e7ca --- /dev/null +++ b/milena/doc/milena.qhcp @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QHelpCollectionProject version="1.0"> + <assistant> + <startPage>qthelp://fr.epita.lrde.olena/milena-2.0/index.html</startPage> + </assistant> + <docFiles> + <register> + <file>user-refman/html/milena.qch</file> + </register> + </docFiles> +</QHelpCollectionProject> \ No newline at end of file diff --git a/scribo/doc/.gitignore b/scribo/doc/.gitignore new file mode 100644 index 0000000..c858430 --- /dev/null +++ b/scribo/doc/.gitignore @@ -0,0 +1,13 @@ +/Doxyfile_user +/user-refman +/user-refman.pdf + +/Doxyfile_devel +/devel-refman +/devel-refman.pdf + +/figures/*.png + +/tutorial.hh +/tutorial.pdf +/tutorial/ diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in new file mode 100644 index 0000000..d279d76 --- /dev/null +++ b/scribo/doc/Doxyfile.in @@ -0,0 +1,373 @@ +# Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +# +# This file is part of Olena. +# +# Olena is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, version 2 of the License. +# +# Olena is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Olena. If not, see <http://www.gnu.org/licenses/>. +# +# Doxyfile 1.5.1 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "Scribo" +PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@" +PROJECT_BRIEF = "An Image Processing Platform" +PROJECT_LOGO = @top_srcdir@/doc/logo.jpg +OUTPUT_DIRECTORY = @builddir@/user-refman.tmp +CREATE_SUBDIRS = YES +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = @top_srcdir@/scribo +STRIP_FROM_INC_PATH = +SHORT_NAMES = YES +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +BUILTIN_STL_SUPPORT = YES +IDL_PROPERTY_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = YES +HIDE_IN_BODY_DOCS = YES +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = YES +SORT_BY_SCOPE_NAME = YES +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = NO # Disabled for light doc +SHOW_DIRECTORIES = NO # Disabled for light doc +SHOW_FILES = NO # Disabled for light doc +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = @top_srcdir@/scribo +FILE_PATTERNS = *.cc \ + *.hh \ + *.hxx \ + *.hcc +RECURSIVE = YES +EXCLUDE = @top_srcdir@/scribo/demo \ + @top_srcdir@/scribo/sandbox \ + @top_srcdir@/scribo/doc/user-refman \ + @top_srcdir@/scribo/doc/devel-refman \ + @top_srcdir@/scribo/tests/unit_test +EXCLUDE_SYMLINKS = YES +EXCLUDE_PATTERNS = *spe.hh +EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::* +EXAMPLE_PATH = @top_srcdir@/scribo/doc/examples \ + @top_srcdir@/scribo/doc/outputs \ + @top_srcdir@/scribo/doc/examples/split \ + @top_srcdir@/scribo/doc/outputs/split +EXAMPLE_PATTERNS = *.cc \ + *.cc.raw \ + *.txt +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = @top_srcdir@/scribo/doc/img \ + @top_srcdir@/scribo/doc/figures +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +INPUT_ENCODING = ISO-8859-1 + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = NO +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = mln:: +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = @top_srcdir@/doc/header.html +HTML_FOOTER = @top_srcdir@/doc/subdoc_footer.html +HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css +LAYOUT_FILE = @top_srcdir@/scribo/doc/DoxygenLayout.xml +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = YES +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = YES +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \ + "for_all_2(x1, x2)=for(x1.start(), x2.start(); x1.is_valid(); x1.next(), x2.next())" \ + "for_all_3(x1, x2, x3)=for(x1.start(), x2.start(), x3.start(); x1.is_valid(); x1.next(), x2.next(), x3.next())" \ + "for_all_remaining(x)=if (! x.is_valid()) {} else while (x.next(), x.is_valid())" \ + "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret" \ + "mlc_equal(T1,T2)=mln::metal::equal<T1,T2>" \ + "mln_piter(T)=typename T::piter" \ + "mln_fwd_piter(T)=typename T::fwd_piter" \ + "mln_bkd_piter(T)=typename T::bkd_piter" \ + "mln_qiter(T)=typename T::qiter" \ + "mln_fwd_qiter(T)=typename T::fwd_qiter" \ + "mln_bkd_qiter(T)=typename T::bkd_qiter" \ + "mln_niter(T)=typename T::niter" \ + "mln_fwd_niter(T)=typename T::fwd_niter" \ + "mln_bkd_niter(T)=typename T::bkd_niter" \ + "mln_viter(T)=typename T::viter" \ + "mln_fwd_viter(T)=typename T::fwd_viter" \ + "mln_bkd_viter(T)=typename T::bkd_viter" \ + "mln_result(T)=typename T::result" \ + "mln_enc(T)=typename T::enc" \ + "mln_value(T)=typename T::value" \ + "mln_qlf_value(T)=typename T::qlf_value" \ + "mln_domain(T)=typename T::domain_t" \ + "mln_sum(T)=typename mln::value::props<T>::sum" \ + "mln_vset(T)=typename T::vset" \ + "mln_rvalue(T)=typename T::rvalue" \ + "mln_lvalue(T)=typename T::lvalue" \ + "mln_mesh(T)=typename T::mesh" \ + "mln_coord(T)=typename T::coord" \ + "mln_site(T)=typename T::site" \ + "mln_psite(T)=typename T::psite" \ + "mln_dpsite(T)=typename T::dpsite" \ + "mln_accu_with(A, T)=typename A::template with< T >::ret" \ + "mln_trait_op_div(L, R)=typename mln::trait::op::div< L , R >::ret" \ + "mln_trait_op_less(L, R)=typename mln::trait::op::less< L , R >::ret" \ + "mln_trait_op_minus(L, R)=typename mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_mod(L, R)=typename mln::trait::op::mod< L , R >::ret" \ + "mln_trait_op_plus(L, R)=typename mln::trait::op::plus< L , R >::ret" \ + "mln_trait_op_times(L, R)=typename mln::trait::op::times< L , R >::ret" \ + "mln_trait_op_uminus(T)=typename mln::trait::op::uminus< T >::ret" \ + "mln_ch_value(I, V)=typename mln::trait::ch_value< I, V >::ret" \ + "mlc_unqualif_(T)=mln::metal::unqualif<T>::ret" \ + "mln_piter_(T)=T::piter" \ + "mln_fwd_piter_(T)=T::fwd_piter" \ + "mln_bkd_piter_(T)=T::bkd_piter" \ + "mln_qiter_(T)=T::qiter" \ + "mln_fwd_qiter_(T)=T::fwd_qiter" \ + "mln_bkd_qiter_(T)=T::bkd_qiter" \ + "mln_niter_(T)=T::niter" \ + "mln_fwd_niter_(T)=T::fwd_niter" \ + "mln_bkd_niter_(T)=T::bkd_niter" \ + "mln_viter_(T)=T::viter" \ + "mln_fwd_viter_(T)=T::fwd_viter" \ + "mln_bkd_viter_(T)=T::bkd_viter" \ + "mln_result_(T)=T::result" \ + "mln_enc_(T)=T::enc" \ + "mln_value_(T)=T::value" \ + "mln_qlf_value_(T)=T::qlf_value" \ + "mln_domain_(T)=T::domain_t" \ + "mln_sum_(T)=mln::value::props<T>::sum" \ + "mln_vset_(T)=T::vset" \ + "mln_rvalue_(T)=T::rvalue" \ + "mln_lvalue_(T)=T::lvalue" \ + "mln_mesh_(T)=T::mesh" \ + "mln_coord_(T)=T::coord" \ + "mln_site_(T)=T::site" \ + "mln_psite_(T)=T::psite" \ + "mln_dpsite_(T)=T::dpsite" \ + "mln_accu_with_(A, T)=A::template with< T >::ret" \ + "mln_trait_op_plus_(L, R)=mln::trait::op::plus< L , R >::ret" \ + "mln_trait_op_minus_(L, R)=mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_times_(L, R)=mln::trait::op::times< L , R >::ret" \ + "mln_trait_op_div_(L, R)=mln::trait::op::div< L , R >::ret" \ + "mln_trait_op_mod_(L, R)=mln::trait::op::mod< L , R >::ret" \ + "mln_trait_op_uminus_(T)=mln::trait::op::uminus< T >::ret" \ + "mln_ch_value_(I, V)=typename mln::trait::ch_value< I, V >::ret" \ + "mln_ch_value(I, V)_=mln::trait::ch_value< I, V >::ret" \ + "mln_morpher_lvalue(I)=typename internal::morpher_lvalue_<I>::ret" \ + "mln_concrete(I)=typename mln::trait::concrete< I >::ret" \ + "mln_concrete_ch_value(I, V)=typename mln::trait::ch_value< typename mln::trait::concrete< I >::ret, V >::ret" \ + "mlc_const(T)=typename mln::metal::const_< T >::ret" \ + "mlc_const_return(T)=typename mln::metal::const_return_< T >::ret" \ + "mln_element(T)=typename T::element" \ + "mln_element_(T)=T::element" \ + "mln_delta(T)=typename T::delta" \ + "mln_delta_(T)=T::delta" \ + "mln_dpoint(T)=typename T::dpoint" \ + "mln_dpoint_(T)=T::dpoint" \ + "mln_point(T)=typename T::point" \ + "mln_point_(T)=T::point" \ + "mln_gradient_component(I)=typename mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret" \ + "mln_gradient(I)=mln::value::stack_image< I::point::dim, mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret >" \ + "mln_trait_value_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \ + "mln_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \ + "mln_deduce(T, A1, A2)=typename T::A1::A2" \ + "mln_graph_element(T)=typename T::graph_element" \ + "mln_graph_element_(T)=T::graph_element" \ + "mln_fun_vv2v(F, L, R)=mln::fun::vv2v::F< mln_value(L), mln_value(R) >" \ + "mln_fun_vv2v_result(F, L, R)=typename mln_fun_vv2v(F, L, R)::result" \ + "mln_ch_fun_vv2v(F, L, R)=typename mln::trait::ch_value< L, typename mln_fun_vv2v(F, L, R)::result >::ret" + + + + +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = @builddir@/../../milena/doc/milena.tag=../../../../milena/doc/user-refman/html +GENERATE_TAGFILE = scribo.tag +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = NO +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = NO +COLLABORATION_GRAPH = NO # Disabled for light doc +GROUP_GRAPHS = NO # Disabled for light doc +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = NO # Disabled for light doc +INCLUDED_BY_GRAPH = NO # Disabled for light doc +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = NO +DIRECTORY_GRAPH = NO # Disabled for light doc +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_DEPTH = 1000 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = NO # Disabled for light doc +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = YES + +GENERATE_QHP = yes +QHP_NAMESPACE = "fr.epita.lrde.olena.scribo" +QHP_VIRTUAL_FOLDER = "scribo-2.0" +QCH_FILE = "@builddir@/scribo.qch" +QHG_LOCATION = "qhelpgenerator" + + +# Local Variables: +# mode: Makefile +# End: diff --git a/scribo/doc/DoxygenLayout.xml b/scribo/doc/DoxygenLayout.xml new file mode 100644 index 0000000..ac34f54 --- /dev/null +++ b/scribo/doc/DoxygenLayout.xml @@ -0,0 +1,184 @@ +<doxygenlayout version="1.0"> + <!-- Navigation index tabs for HTML output --> + <navindex> + <tab type="mainpage" visible="yes" title="Scribo"/> + <tab type="pages" visible="yes" title=""/> + <tab type="modules" visible="yes" title=""/> + <tab type="namespaces" visible="yes" title=""> + <tab type="namespaces" visible="yes" title=""/> + <tab type="namespacemembers" visible="yes" title=""/> + </tab> + <tab type="classes" visible="yes" title=""> + <tab type="classes" visible="yes" title=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="yes" title=""/> + <tab type="classmembers" visible="yes" title=""/> + </tab> + <tab type="files" visible="yes" title=""> + <tab type="files" visible="yes" title=""/> + <tab type="globals" visible="yes" title=""/> + </tab> + <tab type="dirs" visible="yes" title=""/> + <tab type="examples" visible="yes" title=""/> + </navindex> + + <!-- Layout definition for a class page --> + <class> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <allmemberslink visible="yes"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + + <!-- Layout definition for a namespace page --> + <namespace> + <briefdescription visible="yes"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + + <!-- Layout definition for a file page --> + <file> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + </file> + + <!-- Layout definition for a group page --> + <group> + <briefdescription visible="yes"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <dirs visible="yes" title=""/> + <nestedgroups visible="yes" title=""/> + <files visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <pagedocs/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + + <!-- Layout definition for a directory page --> + <directory> + <briefdescription visible="yes"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + </directory> +</doxygenlayout> diff --git a/scribo/doc/Makefile.am b/scribo/doc/Makefile.am new file mode 100644 index 0000000..f1fae6c --- /dev/null +++ b/scribo/doc/Makefile.am @@ -0,0 +1,250 @@ +# Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE). +# +# This file is part of Olena. +# +# Olena is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, version 2 of the License. +# +# Olena is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Olena. If not, see <http://www.gnu.org/licenses/>. + + +# Look for Scribo headers in srcdir and for (generated) test headers +# (like data.hh) in builddir. +AM_CPPFLAGS = -I$(top_srcdir)/scribo -I$(top_builddir)/scribo + +DOXYGEN = doxygen + +DOXYFILE = Doxyfile + +DATA_html_dirs = + +## --------------------- ## +## LaTeX configuration. ## +## --------------------- ## + +include $(top_srcdir)/build-aux/tex.mk + +TEXI2DVI_FLAGS += \ + -I $(srcdir) -I $(srcdir)/outputs -I $(srcdir)/outputs/split \ + -I $(srcdir)/img -I $(srcdir)/examples/split + +# Additional files for LaTeX compilations. +DOC_PACKAGES = doxyfuns.sty scribo.sty + + +# ----------------------- # +# User Reference Manual. # +# ----------------------- # + +all-local: $(srcdir)/$(USER_REFMAN) + +# Run "make regen-doc" to forcefully rebuild the Doxygen documentation. +.PHONY: regen-doc +regen-doc: + rm -f $(srcdir)/user-refman.stamp + $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/user-refman.stamp + +DOXYFILE_USER = Doxyfile_user + +# Sed is used to generate Doxyfile from Doxyfile.in instead of +# configure, because the former is way faster than the latter. +# +## FIXME: This is because, as in TC, we depend on $Id$ from the +## ChangeLog. Maybe we should depend from something less prone to +## change. See Bison's build system. +edit = sed -e "s|@ID@|$$Id|" \ + -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \ + -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \ + -e 's,@top_srcdir\@,$(top_srcdir),g' \ + -e 's,@top_builddir\@,$(top_builddir),g' \ + -e 's,@srcdir\@,$(srcdir),g' \ + -e 's,@builddir\@,$(builddir),g' + +$(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in + Id=`grep '^\$$Id' $(top_srcdir)/scribo/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@ +MAINTAINERCLEANFILES = $(DOXYFILE_USER) + +USER_REFMAN = user-refman + +# PDF. +USER_REFMAN_PDF = user-refman.pdf +dist_pdf_DATA = $(srcdir)/$(USER_REFMAN_PDF) + +$(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN) + cd $(srcdir)/$(USER_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf + cp -f $(srcdir)/$(USER_REFMAN)/latex/refman.pdf $@ + +# HTML. +EXTRA_DIST = $(srcdir)/user-refman.stamp +MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp +$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) + @rm -f $@.tmp + @touch $@.tmp + rm -rf $(USER_REFMAN).tmp + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER) + $(DOXYGEN) $(DOXYFILE_USER) +## Doxygen may generate an incomplete output and exit with success! +## Check some files before deeming the output as acceptable. + test -f $(USER_REFMAN).tmp/latex/refman.tex + rm -rf $(srcdir)/$(USER_REFMAN) +## FIXME: Moving directories between file systems is not portable. + mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + @mv -f $@.tmp $@ + +$(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +# Installing a directory located in the source dir is not supported by +# Automake by default, so we cannot simply add `$(USER_REFMAN)/html' +# to `dist_doc_DATA'. The rule `install-data-local' (see below) used +# to work around this limitation is borrowed from the Vaucanson +# project. +EXTRA_DIST += $(USER_REFMAN) + + +# ---------------------------- # +# Developer Reference Manual. # +# ---------------------------- # + +# Run "make regen-devel-doc" to forcefully rebuild the Doxygen +# developer documentation. +.PHONY: regen-devel-doc +regen-devel-doc: + rm -f $(srcdir)/devel-refman.stamp + $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/devel-refman.stamp + +DOXYFILE_DEVEL = Doxyfile_devel + +edit_devel = sed \ + -e 's,OUTPUT_DIRECTORY = @builddir@/user-refman.tmp,OUTPUT_DIRECTORY = @builddir@/devel-refman.tmp,' \ + -e 's,EXTRACT_ALL = NO,EXTRACT_ALL = YES,' \ + -e 's,EXTRACT_PRIVATE = NO,EXTRACT_PRIVATE = YES,' \ + -e 's,EXTRACT_STATIC = NO,EXTRACT_STATIC = YES,' \ + -e 's,EXTRACT_LOCAL_CLASSES = NO,EXTRACT_LOCAL_CLASSES = YES,' \ + -e 's,HIDE_UNDOC_MEMBERS = YES,HIDE_UNDOC_MEMBERS = NO,' \ + -e 's,HIDE_UNDOC_CLASSES = YES,HIDE_UNDOC_CLASSES = NO,' \ + -e 's,HIDE_FRIEND_COMPOUNDS = YES,HIDE_FRIEND_COMPOUNDS = NO,' \ + -e 's,HIDE_IN_BODY_DOCS = YES,HIDE_IN_BODY_DOCS = NO,' \ + -e 's,INTERNAL_DOCS = NO,INTERNAL_DOCS = YES,' \ + -e 's,GENERATE_TODOLIST = NO,GENERATE_TODOLIST = YES,' \ + -e 's,PROJECT_NUMBER = \"User documentation ,PROJECT_NUMBER = \",' \ + -e 's,EXCLUDE_SYMBOLS = \*::internal\* \*_ mln::trait::\*,EXCLUDE_SYMBOLS =,' + +$(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in + rm -f $@.tmp + Id=`grep '^\$$Id' $(top_srcdir)/scribo/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@.tmp + $(edit_devel) $@.tmp >$@ + rm -f $@.tmp +MAINTAINERCLEANFILES += $(DOXYFILE_DEVEL) + +DEVEL_REFMAN = devel-refman + +# PDF. +DEVEL_REFMAN_PDF = devel-refman.pdf +# Be warned, most LaTeX installations will not be able to compile the +# PDF development documentation as-is, as TeX's default memory +# capacities are usually too small to handle such a large document. +$(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) + cd $(srcdir)/$(DEVEL_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf + cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ + +# HTML. +MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp +$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) + @rm -f $@.tmp + @touch $@.tmp + rm -rf $(DEVEL_REFMAN).tmp + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_DEVEL) + $(DOXYGEN) $(DOXYFILE_DEVEL) +## Doxygen may generate an incomplete output and exit with success! +## Check some files before deeming the output as acceptable. + test -f $(DEVEL_REFMAN).tmp/latex/refman.tex + rm -rf $(srcdir)/$(DEVEL_REFMAN) +## FIXME: Moving directories between file systems is not portable. + mv $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) + @mv -f $@.tmp $@ + +$(srcdir)/$(DEVEL_REFMAN): $(srcdir)/devel-refman.stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +## -------------- ## +## Distribution. ## +## -------------- ## + +EXTRA_DIST += \ + $(DATA_html_dirs) \ + $(DOXYFILE).in \ + doxyfuns.sty \ + scribo.sty \ + tools/clearbanner.sh \ + tools/sample_utils.hh \ + tools/split_sample.sh \ + tools/todoxygen.sh + + +## ---------- ## +## Cleaning. ## +## ---------- ## + +MAINTAINERCLEANFILES += $(dist_pdf_DATA) + +maintainer-clean-local: + -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) + -for d in $(DATA_html_dirs); do \ + rm -rf $$d.tmp $(srcdir)/$$d; \ + done + + +## -------------- ## +## Installation. ## +## -------------- ## + +# We install by hand, otherwise Automake produces "install .../srcdoc +# .../srcdoc", which installs our dir into the previous one, instead +# of replacing it. +install-data-local: + $(mkdir_p) $(DESTDIR)$(htmldir) +# The user reference manual is located in a subdirectory, hence this +# special case. + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) + cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) +# Other HTML directories can be processed uniformly. + for d in $(DATA_html_dirs_inst); do \ + rm -rf $(DESTDIR)$(htmldir)/$$d; \ + cp -r $(srcdir)/$$d $(DESTDIR)$(htmldir); \ + done +## Try GNU chmod's X mode before resorting to something slower but +## more standard. + chmod -R a+rX $(DESTDIR)$(htmldir) || \ + find $(DESTDIR)$(htmldir) \( -type d -a -exec chmod a+rx {} \; \) \ + -o -exec chmod a+r {} \; + +uninstall-local: + for d in $(DATA_html_dirs_inst); do \ + chmod -R 700 $(DESTDIR)$(htmldir)/$$d; \ + rm -rf $(DESTDIR)$(htmldir)/$$d; \ + done +# Same remark as above regarding the special case of the user +# reference manual. + chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) diff --git a/milena/doc/doxyfuns.sty b/scribo/doc/doxyfuns.sty similarity index 100% copy from milena/doc/doxyfuns.sty copy to scribo/doc/doxyfuns.sty diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/examples-outputs.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/examples-outputs.mk diff --git a/scribo/doc/examples.mk b/scribo/doc/examples.mk new file mode 100644 index 0000000..c7181cc --- /dev/null +++ b/scribo/doc/examples.mk @@ -0,0 +1,4 @@ +## Generated by gen-make-variable. Do not edit by hand. + +EXAMPLES = \ + $(srcdir)/examples/dummy.cc diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/examples/dummy.cc similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/examples/dummy.cc diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/figures.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/figures.mk diff --git a/milena/doc/gen-examples-outputs-mk b/scribo/doc/gen-examples-outputs-mk similarity index 100% copy from milena/doc/gen-examples-outputs-mk copy to scribo/doc/gen-examples-outputs-mk diff --git a/milena/doc/gen-figures-mk b/scribo/doc/gen-figures-mk similarity index 100% copy from milena/doc/gen-figures-mk copy to scribo/doc/gen-figures-mk diff --git a/milena/doc/gen-make-variable b/scribo/doc/gen-make-variable similarity index 100% copy from milena/doc/gen-make-variable copy to scribo/doc/gen-make-variable diff --git a/milena/doc/gen-split-examples-mk b/scribo/doc/gen-split-examples-mk similarity index 100% copy from milena/doc/gen-split-examples-mk copy to scribo/doc/gen-split-examples-mk diff --git a/milena/doc/gen-split-outputs-mk b/scribo/doc/gen-split-outputs-mk similarity index 100% copy from milena/doc/gen-split-outputs-mk copy to scribo/doc/gen-split-outputs-mk diff --git a/milena/doc/graphicx.hva b/scribo/doc/graphicx.hva similarity index 100% copy from milena/doc/graphicx.hva copy to scribo/doc/graphicx.hva diff --git a/scribo/doc/outputs.mk b/scribo/doc/outputs.mk new file mode 100644 index 0000000..09a1efd --- /dev/null +++ b/scribo/doc/outputs.mk @@ -0,0 +1,4 @@ +## Generated by gen-make-variable. Do not edit by hand. + +OUTPUTS = \ + $(srcdir)/outputs/dummy.txt diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/outputs/dummy.txt similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/outputs/dummy.txt diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/programs-examples.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/programs-examples.mk diff --git a/scribo/doc/scribo.qhcp b/scribo/doc/scribo.qhcp new file mode 100644 index 0000000..77269b5 --- /dev/null +++ b/scribo/doc/scribo.qhcp @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QHelpCollectionProject version="1.0"> + <assistant> + <startPage>qthelp://fr.epita.lrde.olena/scribo-2.0/index.html</startPage> + </assistant> + <docFiles> + <register> + <file>user-refman/html/scribo.qch</file> + </register> + </docFiles> +</QHelpCollectionProject> \ No newline at end of file diff --git a/milena/doc/milena.sty b/scribo/doc/scribo.sty similarity index 100% copy from milena/doc/milena.sty copy to scribo/doc/scribo.sty diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/split-examples.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/split-examples.mk diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/split-outputs.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/split-outputs.mk diff --git a/milena/doc/tools/todoxygen.sh b/scribo/doc/tools/todoxygen.sh similarity index 100% copy from milena/doc/tools/todoxygen.sh copy to scribo/doc/tools/todoxygen.sh diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/tutorial.tex similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/tutorial.tex -- 1.7.2.5