[Olena-patches] olena-2.0-66-gfa49a34 Add new groups in Scribo documentation.

* doc/Doxyfile.in: Refine settings. * doc/groups.dox: Add new groups. * scribo/core/component_set.hh, * scribo/core/document.hh, * scribo/core/line_links.hh, * scribo/core/line_set.hh, * scribo/core/object_groups.hh, * scribo/core/object_links.hh, * scribo/core/paragraph_set.hh: Set to a documentation group. --- ChangeLog | 16 ++++++++++++++++ scribo/doc/Doxyfile.in | 13 ++++++++----- scribo/doc/groups.dox | 19 +++++++++++++++++++ scribo/scribo/core/component_set.hh | 4 ++++ scribo/scribo/core/document.hh | 7 +++++-- scribo/scribo/core/line_links.hh | 4 +++- scribo/scribo/core/line_set.hh | 7 +++++-- scribo/scribo/core/object_groups.hh | 2 ++ scribo/scribo/core/object_links.hh | 4 +++- scribo/scribo/core/paragraph_set.hh | 1 + 10 files changed, 66 insertions(+), 11 deletions(-) create mode 100644 scribo/doc/groups.dox diff --git a/ChangeLog b/ChangeLog index bb6ddc8..d796c0b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,21 @@ 2012-02-01 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Add new groups in Scribo documentation. + + * doc/Doxyfile.in: Refine settings. + + * doc/groups.dox: Add new groups. + + * scribo/core/component_set.hh, + * scribo/core/document.hh, + * scribo/core/line_links.hh, + * scribo/core/line_set.hh, + * scribo/core/object_groups.hh, + * scribo/core/object_links.hh, + * scribo/core/paragraph_set.hh: Set to a documentation group. + +2012-02-01 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Improve common documentation. * AUTHORS: Use RST syntax. diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in index d279d76..7ad639f 100644 --- a/scribo/doc/Doxyfile.in +++ b/scribo/doc/Doxyfile.in @@ -26,7 +26,7 @@ PROJECT_LOGO = @top_srcdir@/doc/logo.jpg OUTPUT_DIRECTORY = @builddir@/user-refman.tmp CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English -BRIEF_MEMBER_DESC = YES +BRIEF_MEMBER_DESC = NO REPEAT_BRIEF = YES ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES @@ -47,6 +47,8 @@ BUILTIN_STL_SUPPORT = YES IDL_PROPERTY_SUPPORT = NO DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +SORT_GROUP_NAMES = YES #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -95,7 +97,8 @@ INPUT = @top_srcdir@/scribo FILE_PATTERNS = *.cc \ *.hh \ *.hxx \ - *.hcc + *.hcc \ + *.dox RECURSIVE = YES EXCLUDE = @top_srcdir@/scribo/demo \ @top_srcdir@/scribo/sandbox \ @@ -126,8 +129,8 @@ INPUT_ENCODING = ISO-8859-1 SOURCE_BROWSER = YES INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO REFERENCES_LINK_SOURCE = NO USE_HTAGS = NO VERBATIM_HEADERS = YES @@ -329,7 +332,7 @@ SKIP_FUNCTION_MACROS = YES TAGFILES = @builddir@/../../milena/doc/milena.tag=../../../../milena/doc/user-refman/html GENERATE_TAGFILE = scribo.tag ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES +EXTERNAL_GROUPS = NO PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool diff --git a/scribo/doc/groups.dox b/scribo/doc/groups.dox new file mode 100644 index 0000000..73d842e --- /dev/null +++ b/scribo/doc/groups.dox @@ -0,0 +1,19 @@ +/*! \defgroup grpstruct Data structures + * + * \brief Scribo high level data structures. + * + */ + + +/*! \defgroup grproutine Routines + * + * \brief All routines/algorithms provided in Scribo. + * + */ + + +/*! \defgroup grpalgobin Binarization + * + * \brief Binarization algorithms. + * + */ diff --git a/scribo/scribo/core/component_set.hh b/scribo/scribo/core/component_set.hh index ded64ae..8c3e83f 100644 --- a/scribo/scribo/core/component_set.hh +++ b/scribo/scribo/core/component_set.hh @@ -119,6 +119,10 @@ namespace scribo } // end of namespace scribo::internal + /// \brief Represents all the components in a document image. + /// + /// \ingroup grpstruct + // template <typename L> class component_set : public Serializable<component_set<L> > { diff --git a/scribo/scribo/core/document.hh b/scribo/scribo/core/document.hh index cc885e4..5bbd226 100644 --- a/scribo/scribo/core/document.hh +++ b/scribo/scribo/core/document.hh @@ -79,9 +79,12 @@ namespace scribo } // end of namespace scribo::internal - + /// \brief Represent document data and structure. + /// + /// \ingroup grpstruct + // template <typename L> - struct document : public Serializable<document<L> > + class document : public Serializable<document<L> > { typedef internal::document_data<L> data_t; diff --git a/scribo/scribo/core/line_links.hh b/scribo/scribo/core/line_links.hh index b7b438c..4f807e4 100644 --- a/scribo/scribo/core/line_links.hh +++ b/scribo/scribo/core/line_links.hh @@ -67,7 +67,9 @@ namespace scribo - /// \brief Line group representation. + /// \brief Line links representation. + /// + /// \ingroup grpstruct // template <typename L> class line_links : public Serializable<line_links<L> > diff --git a/scribo/scribo/core/line_set.hh b/scribo/scribo/core/line_set.hh index db987e6..4880a77 100644 --- a/scribo/scribo/core/line_set.hh +++ b/scribo/scribo/core/line_set.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2010, 2011 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -86,6 +86,9 @@ namespace scribo Line ids start from 1. + + \ingroup grpstruct + */ template <typename L> class line_set diff --git a/scribo/scribo/core/object_groups.hh b/scribo/scribo/core/object_groups.hh index 46447d2..53ba7f9 100644 --- a/scribo/scribo/core/object_groups.hh +++ b/scribo/scribo/core/object_groups.hh @@ -88,6 +88,8 @@ namespace scribo /// \brief Object group representation. + /// + /// \ingroup grpstruct // template <typename L> class object_groups : public Serializable<object_groups<L> > diff --git a/scribo/scribo/core/object_links.hh b/scribo/scribo/core/object_links.hh index 37fd299..a2543a7 100644 --- a/scribo/scribo/core/object_links.hh +++ b/scribo/scribo/core/object_links.hh @@ -69,7 +69,9 @@ namespace scribo - /// \brief Object group representation. + /// \brief Object links representation. + /// + /// \ingroup grpstruct // template <typename L> class object_links : public Serializable<object_links<L> > diff --git a/scribo/scribo/core/paragraph_set.hh b/scribo/scribo/core/paragraph_set.hh index c21359d..69194be 100644 --- a/scribo/scribo/core/paragraph_set.hh +++ b/scribo/scribo/core/paragraph_set.hh @@ -65,6 +65,7 @@ namespace scribo Paragraph ids start from 1. + \ingroup grpstruct */ template <typename L> class paragraph_set : public Serializable<paragraph_set<L> > -- 1.7.2.5