[Olena-patches] olena-2.0-59-g516e8d4 First draft of Scribo documentation.

* scribo/doc/.gitignore, * scribo/doc/Doxyfile.in, * scribo/doc/DoxygenLayout.xml, * scribo/doc/Makefile.am, * scribo/doc/doxyfuns.sty, * scribo/doc/examples-outputs.mk, * scribo/doc/examples.mk, * scribo/doc/examples/dummy.cc, * scribo/doc/figures.mk, * scribo/doc/gen-examples-outputs-mk, * scribo/doc/gen-figures-mk, * scribo/doc/gen-make-variable, * scribo/doc/gen-split-examples-mk, * scribo/doc/gen-split-outputs-mk, * scribo/doc/graphicx.hva, * scribo/doc/outputs.mk, * scribo/doc/outputs/dummy.txt, * scribo/doc/programs-examples.mk, * scribo/doc/scribo.qhcp, * scribo/doc/scribo.sty, * scribo/doc/split-examples.mk, * scribo/doc/split-outputs.mk, * scribo/doc/tools/todoxygen.sh, * scribo/doc/tutorial.tex: New. --- ChangeLog | 29 ++ 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 25 files changed, 868 insertions(+), 0 deletions(-) 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/ChangeLog b/ChangeLog index b7099ec..473c3d1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,34 @@ 2012-01-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + First draft of Scribo documentation. + + * scribo/doc/.gitignore, + * scribo/doc/Doxyfile.in, + * scribo/doc/DoxygenLayout.xml, + * scribo/doc/Makefile.am, + * scribo/doc/doxyfuns.sty, + * scribo/doc/examples-outputs.mk, + * scribo/doc/examples.mk, + * scribo/doc/examples/dummy.cc, + * scribo/doc/figures.mk, + * scribo/doc/gen-examples-outputs-mk, + * scribo/doc/gen-figures-mk, + * scribo/doc/gen-make-variable, + * scribo/doc/gen-split-examples-mk, + * scribo/doc/gen-split-outputs-mk, + * scribo/doc/graphicx.hva, + * scribo/doc/outputs.mk, + * scribo/doc/outputs/dummy.txt, + * scribo/doc/programs-examples.mk, + * scribo/doc/scribo.qhcp, + * scribo/doc/scribo.sty, + * scribo/doc/split-examples.mk, + * scribo/doc/split-outputs.mk, + * scribo/doc/tools/todoxygen.sh, + * scribo/doc/tutorial.tex: New. + +2012-01-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + First draft of common documentation. * configure.ac: Add new makefiles. 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