On 23 October 2015 at 03:00, Petri Savolainen <petri.savolai...@nokia.com> wrote:
> Group level documentation can be used for API level general > description. Layout file is needed to place detailed group > description on the top of a page. By default doxygen shows > only the brief description on top (the first sentence). > > Signed-off-by: Petri Savolainen <petri.savolai...@nokia.com> > Reviewed-by: Mike Holmes <mike.hol...@linaro.org> > --- > doc/doxygen.cfg | 1 + > doc/doxygenlayout.xml | 193 > ++++++++++++++++++++++++++++++++++++++++++++++++++ > 2 files changed, 194 insertions(+) > create mode 100644 doc/doxygenlayout.xml > > diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg > index f28ec24..909f0ce 100644 > --- a/doc/doxygen.cfg > +++ b/doc/doxygen.cfg > @@ -33,6 +33,7 @@ EXAMPLE_PATTERNS = *.c > EXAMPLE_RECURSIVE = YES > IMAGE_PATH = $(SRCDIR)/doc/images > HTML_EXTRA_STYLESHEET = $(SRCDIR)/doc/odpdoxygen.css > +LAYOUT_FILE = $(SRCDIR)/doc/doxygenlayout.xml > ENABLE_PREPROCESSING = YES > MACRO_EXPANSION = YES > EXPAND_ONLY_PREDEF = YES > diff --git a/doc/doxygenlayout.xml b/doc/doxygenlayout.xml > new file mode 100644 > index 0000000..90e189a > --- /dev/null > +++ b/doc/doxygenlayout.xml > @@ -0,0 +1,193 @@ > +<doxygenlayout version="1.0"> > + <!-- Navigation index tabs for HTML output --> > + <navindex> > + <tab type="mainpage" visible="yes" title=""/> > + <tab type="pages" visible="yes" title="" intro=""/> > + <tab type="modules" visible="yes" title="" intro=""/> > + <tab type="namespaces" visible="yes" title=""> > + <tab type="namespacelist" visible="yes" title="" intro=""/> > + <tab type="namespacemembers" visible="yes" title="" intro=""/> > + </tab> > + <tab type="classes" visible="yes" title=""> > + <tab type="classlist" visible="yes" title="" intro=""/> > + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> > + <tab type="hierarchy" visible="yes" title="" intro=""/> > + <tab type="classmembers" visible="yes" title="" intro=""/> > + </tab> > + <tab type="files" visible="yes" title=""> > + <tab type="filelist" visible="yes" title="" intro=""/> > + <tab type="globals" visible="yes" title="" intro=""/> > + </tab> > + <tab type="examples" visible="yes" title="" intro=""/> > + </navindex> > + > + <!-- Layout definition for a class page --> > + <class> > + <briefdescription visible="yes"/> > + <includes visible="$SHOW_INCLUDE_FILES"/> > + <inheritancegraph visible="$CLASS_GRAPH"/> > + <collaborationgraph visible="$COLLABORATION_GRAPH"/> > + <memberdecl> > + <nestedclasses visible="yes" title=""/> > + <publictypes title=""/> > + <services title=""/> > + <interfaces 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> > + <inlineclasses title=""/> > + <typedefs title=""/> > + <enums title=""/> > + <services title=""/> > + <interfaces title=""/> > + <constructors title=""/> > + <functions title=""/> > + <related title=""/> > + <variables title=""/> > + <properties title=""/> > + <events title=""/> > + </memberdef> > + <allmemberslink visible="yes"/> > + <usedfiles visible="$SHOW_USED_FILES"/> > + <authorsection visible="yes"/> > + </class> > + > + <!-- Layout definition for a namespace page --> > + <namespace> > + <briefdescription visible="yes"/> > + <memberdecl> > + <nestednamespaces visible="yes" title=""/> > + <constantgroups visible="yes" title=""/> > + <classes visible="yes" title=""/> > + <typedefs title=""/> > + <enums title=""/> > + <functions title=""/> > + <variables title=""/> > + <membergroups visible="yes"/> > + </memberdecl> > + <detaileddescription title=""/> > + <memberdef> > + <inlineclasses title=""/> > + <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=""/> > + <constantgroups visible="yes" title=""/> > + <defines title=""/> > + <typedefs title=""/> > + <enums title=""/> > + <functions title=""/> > + <variables title=""/> > + <membergroups visible="yes"/> > + </memberdecl> > + <detaileddescription title=""/> > + <memberdef> > + <inlineclasses title=""/> > + <defines title=""/> > + <typedefs title=""/> > + <enums title=""/> > + <functions title=""/> > + <variables title=""/> > + </memberdef> > + <authorsection/> > + </file> > + > + <!-- Layout definition for a group page --> > + <group> > + <briefdescription visible="no"/> > + <detaileddescription visible="yes" title="API Description"/> > + <groupgraph visible="$GROUP_GRAPHS"/> > + <memberdecl> > + <nestedgroups visible="yes" title=""/> > + <dirs visible="yes" title=""/> > + <files visible="yes" title=""/> > + <namespaces visible="yes" title=""/> > + <classes 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> > + <memberdef> > + <pagedocs/> > + <inlineclasses 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=""/> > + </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> > -- > 2.6.2 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
_______________________________________________ lng-odp mailing list lng-odp@lists.linaro.org https://lists.linaro.org/mailman/listinfo/lng-odp
