---
milena/doc/Doxyfile.in | 3 +
milena/doc/DoxygenLayout.xml | 32 +++++++-----
milena/doc/Makefile.am | 6 +-
milena/doc/doxyfuns.sty | 108 ++++++++++++++++++++++++++++--------------
scribo/doc/DoxygenLayout.xml | 32 +++++++-----
scribo/doc/Makefile.am | 6 +-
6 files changed, 117 insertions(+), 70 deletions(-)
diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in
index 4b44d80..181f887 100644
--- a/milena/doc/Doxyfile.in
+++ b/milena/doc/Doxyfile.in
@@ -48,6 +48,9 @@ BUILTIN_STL_SUPPORT = YES
IDL_PROPERTY_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
+INLINE_GROUPED_CLASSES = YES
+SORT_GROUP_NAMES = YES
+TYPEDEF_HIDES_STRUCT = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
diff --git a/milena/doc/DoxygenLayout.xml b/milena/doc/DoxygenLayout.xml
index ff1e5e4..8d23146 100644
--- a/milena/doc/DoxygenLayout.xml
+++ b/milena/doc/DoxygenLayout.xml
@@ -2,24 +2,24 @@
<!-- 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="pages" visible="yes" title=""
intro=""/>
+ <tab type="modules" visible="yes" title=""
intro=""/>
<tab type="namespaces" visible="yes" title="">
- <tab type="namespaces" visible="yes"
title=""/>
- <tab type="namespacemembers" 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="classes" visible="yes" title=""/>
+ <tab type="classlist" visible="yes" title=""
intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX"
title=""/>
- <tab type="hierarchy" visible="yes" title=""/>
- <tab type="classmembers" visible="yes"
title=""/>
+ <tab type="hierarchy" visible="yes" title=""
intro=""/>
+ <tab type="classmembers" visible="yes" title=""
intro=""/>
</tab>
<tab type="files" visible="yes" title="">
- <tab type="files" visible="yes" title=""/>
- <tab type="globals" visible="yes" title=""/>
+ <tab type="filelist" visible="yes" title=""
intro=""/>
+ <tab type="globals" visible="yes" title=""
intro=""/>
</tab>
- <tab type="dirs" visible="yes" title=""/>
- <tab type="examples" visible="yes" title=""/>
+ <tab type="dirs" visible="yes" title=""
intro=""/>
+ <tab type="examples" visible="yes" title=""
intro=""/>
</navindex>
<!-- Layout definition for a class page -->
@@ -63,6 +63,7 @@
</memberdecl>
<detaileddescription title=""/>
<memberdef>
+ <inlineclasses title=""/>
<typedefs title=""/>
<enums title=""/>
<constructors title=""/>
@@ -90,6 +91,7 @@
</memberdecl>
<detaileddescription title=""/>
<memberdef>
+ <inlineclasses title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
@@ -117,6 +119,7 @@
</memberdecl>
<detaileddescription title=""/>
<memberdef>
+ <inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
@@ -131,11 +134,11 @@
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
- <classes visible="yes" title=""/>
- <namespaces visible="yes" title=""/>
- <dirs visible="yes" title=""/>
<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=""/>
@@ -154,6 +157,7 @@
<detaileddescription title=""/>
<memberdef>
<pagedocs/>
+ <inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am
index 321d926..1761308 100644
--- a/milena/doc/Makefile.am
+++ b/milena/doc/Makefile.am
@@ -246,8 +246,8 @@ $(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps)
test -f $(USER_REFMAN).tmp/latex/refman.tex
rm -rf $(srcdir)/$(USER_REFMAN)
## Fix path to the main page of the documentation.
- sed -i -e "s,\@relcommondocpath\@,../../../user-refman/html/,g" \
- $(USER_REFMAN).tmp/html/index.html
+ sed -i -e "s,\@relcommondocpath\@,$(DESTDIR)$(htmldir)/$(USER_REFMAN)/html/,g"
\
+ `find $(USER_REFMAN).tmp -name '*.html'`
## FIXME: Moving directories between file systems is not portable.
mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN)
@mv -f $@.tmp $@
@@ -328,7 +328,7 @@ $(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps)
test -f $(DEVEL_REFMAN).tmp/latex/refman.tex
rm -rf $(srcdir)/$(DEVEL_REFMAN)
## Fix path to the main page of the documentation.
- sed -i -e "s,\@relcommondocpath\@,../,g" \
+ sed -i -e
"s,\@relcommondocpath\@,$(DESTDIR)$(htmldir)/$(DEVEL_REFMAN)/html/,g" \
$(DEVEL_REFMAN).tmp/html/index.html
## FIXME: Moving directories between file systems is not portable.
mv $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN)
diff --git a/milena/doc/doxyfuns.sty b/milena/doc/doxyfuns.sty
index cd8d8bf..aa4cb02 100644
--- a/milena/doc/doxyfuns.sty
+++ b/milena/doc/doxyfuns.sty
@@ -24,11 +24,14 @@
% #2 - sub page title.
\newcommand{\doxychapter}[2]{%
\label{#1}
-\backslash endhtmlonly%
+\backslash endhtmlonly
+%
*/
/*!
-\backslash page #1 #2%
-\backslash htmlonly %
+\backslash page #1 #2
+%
+\backslash htmlonly
+%
}
% #1 - section ref name (one word in lower case).
@@ -36,58 +39,79 @@
\newcommand{\doxysection}[2]{%
\vspace{1cm}
\label{#1}
-\backslash endhtmlonly%
-\backslash section #1 #2%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash section #1 #2
+%
+\backslash htmlonly
+%
}
% #1 - subsection name (one word in lower case).
% #2 - subsection title.
\newcommand{\doxysubsection}[2]{%
\label{#1}
-\backslash endhtmlonly%
-\backslash subsection #1 #2%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash subsection #1 #2
+%
+\backslash htmlonly
+%
}
% #1 - subsubsection name (one word in lower case).
% #2 - subsubsection title.
\newcommand{\doxysubsubsection}[2]{%
\label{#1}
-\backslash endhtmlonly%
-\backslash subsubsection #1 #2%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash subsubsection #1 #2
+%
+\backslash htmlonly
+%
}
% #1 - part number (Optional).
% #2 - sample file name.
\newcommand{\doxycode}[2][1]{
-\backslash endhtmlonly%
-\backslash include #2-#1.cc.raw%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash include #2-#1.cc.raw
+%
+\backslash htmlonly
+%
}
% #1 - sample file name.
\newcommand{\doxyrawcode}[1]{
-\backslash endhtmlonly%
-\backslash include #1.cc.raw%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash include #1.cc.raw
+%
+\backslash htmlonly
+%
}
% #1 - output file name.
\newcommand{\doxyoutput}[1]{
-\backslash endhtmlonly%
-\backslash include #1.txt%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash include #1.txt
+%
+\backslash htmlonly
+%
}
% Include file '#1' from a split output.
% #1 - part number (Optional).
% #2 - sample file name.
\newcommand{\doxymoutput}[2][1]{
-\backslash endhtmlonly%
-\backslash include #2-#1.txt%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash include #2-#1.txt
+%
+\backslash htmlonly
+%
}
% Include an output image.
@@ -95,34 +119,46 @@
% #2 - related sample file name.
% #3 - Size of the picture (Latex ONLY)
\newcommand{\doxyfigure}[3][1]{
-\backslash endhtmlonly%
-\backslash image html #2-#1.png%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash image html #2-#1.png
+%
+\backslash htmlonly
+%
}
% Include an image from located in one of the path specified in IMAGE_PATH.
% #1 - image name.
% #2 - Size of the picture (Latex ONLY)
\newcommand{\doxyimg}[2]{
-\backslash endhtmlonly%
-\backslash image html #1.png%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash image html #1.png
+%
+\backslash htmlonly
+%
}
% Refer to a chapter, section...
% #1 - the reference name.
\newcommand{\doxyref}[1]{
-\backslash endhtmlonly%
-\backslash ref #1%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash ref #1
+%
+\backslash htmlonly
+%
}
% Refers to classes, functions, methods, variables files or URL.
% #1 - the reference name.
\newcommand{\doxysee}[1]{
-\backslash endhtmlonly%
-\backslash see #1%
-\backslash htmlonly %
+\backslash endhtmlonly
+%
+\backslash see #1
+%
+\backslash htmlonly
+%
}
\newcommand{\tutotoc}[2]{%
diff --git a/scribo/doc/DoxygenLayout.xml b/scribo/doc/DoxygenLayout.xml
index ac34f54..e9d1901 100644
--- a/scribo/doc/DoxygenLayout.xml
+++ b/scribo/doc/DoxygenLayout.xml
@@ -2,24 +2,24 @@
<!-- 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="pages" visible="yes" title=""
intro=""/>
+ <tab type="modules" visible="yes" title=""
intro=""/>
<tab type="namespaces" visible="yes" title="">
- <tab type="namespaces" visible="yes"
title=""/>
- <tab type="namespacemembers" 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="classes" visible="yes" title=""/>
+ <tab type="classlist" visible="yes" title=""
intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX"
title=""/>
- <tab type="hierarchy" visible="yes" title=""/>
- <tab type="classmembers" visible="yes"
title=""/>
+ <tab type="hierarchy" visible="yes" title=""
intro=""/>
+ <tab type="classmembers" visible="yes" title=""
intro=""/>
</tab>
<tab type="files" visible="yes" title="">
- <tab type="files" visible="yes" title=""/>
- <tab type="globals" visible="yes" title=""/>
+ <tab type="filelist" visible="yes" title=""
intro=""/>
+ <tab type="globals" visible="yes" title=""
intro=""/>
</tab>
- <tab type="dirs" visible="yes" title=""/>
- <tab type="examples" visible="yes" title=""/>
+ <tab type="dirs" visible="yes" title=""
intro=""/>
+ <tab type="examples" visible="yes" title=""
intro=""/>
</navindex>
<!-- Layout definition for a class page -->
@@ -63,6 +63,7 @@
</memberdecl>
<detaileddescription title=""/>
<memberdef>
+ <inlineclasses title=""/>
<typedefs title=""/>
<enums title=""/>
<constructors title=""/>
@@ -90,6 +91,7 @@
</memberdecl>
<detaileddescription title=""/>
<memberdef>
+ <inlineclasses title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
@@ -117,6 +119,7 @@
</memberdecl>
<detaileddescription title=""/>
<memberdef>
+ <inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
@@ -131,11 +134,11 @@
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
- <classes visible="yes" title=""/>
- <namespaces visible="yes" title=""/>
- <dirs visible="yes" title=""/>
<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=""/>
@@ -154,6 +157,7 @@
<detaileddescription title=""/>
<memberdef>
<pagedocs/>
+ <inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
diff --git a/scribo/doc/Makefile.am b/scribo/doc/Makefile.am
index db72cdd..9cbe355 100644
--- a/scribo/doc/Makefile.am
+++ b/scribo/doc/Makefile.am
@@ -98,8 +98,8 @@ $(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps)
test -f $(USER_REFMAN).tmp/latex/refman.tex
rm -rf $(srcdir)/$(USER_REFMAN)
## Fix path to the main page of the documentation.
- sed -i -e "s,\@relcommondocpath\@,../../../user-refman/html/,g" \
- $(USER_REFMAN).tmp/html/index.html
+ sed -i -e "s,\@relcommondocpath\@,$(DESTDIR)$(htmldir)/$(USER_REFMAN)/html/,g"
\
+ `find $(USER_REFMAN).tmp -name '*.html'`
## FIXME: Moving directories between file systems is not portable.
mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN)
@mv -f $@.tmp $@
@@ -180,7 +180,7 @@ $(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps)
test -f $(DEVEL_REFMAN).tmp/latex/refman.tex
rm -rf $(srcdir)/$(DEVEL_REFMAN)
## Fix path to the main page of the documentation.
- sed -i -e "s,\@relcommondocpath\@,../,g" \
+ sed -i -e
"s,\@relcommondocpath\@,$(DESTDIR)$(htmldir)/$(DEVEL_REFMAN)/html/,g" \
$(DEVEL_REFMAN).tmp/html/index.html
## FIXME: Moving directories between file systems is not portable.
mv $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN)
--
1.7.2.5