From b91d710ef9e95feffbb1c97d3fc7695157e0731e Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Tue, 15 Mar 2005 19:18:42 +0000 Subject: Release-1.4.1-20050315 --- INSTALL | 4 +- README | 4 +- VERSION | 2 +- doc/commands.doc | 53 ++++++++++++++++ doc/grouping.doc | 73 ++++++++++++++-------- doc/index.doc | 2 +- doc/language.doc | 14 ++--- doc/lists.doc | 2 +- doc/translator_report.txt | 66 ++------------------ packages/rpm/doxygen.spec | 2 +- src/bufstr.h | 5 ++ src/classdef.cpp | 9 +-- src/cmdmapper.cpp | 1 + src/cmdmapper.h | 42 ++++++------- src/commentscan.l | 150 +++++++++++++++++++++++++-------------------- src/config.l | 1 + src/definition.cpp | 5 ++ src/docparser.cpp | 47 +------------- src/doctokenizer.l | 10 +-- src/doxygen.cpp | 152 ++++++++++++++++++++++++---------------------- src/index.cpp | 8 ++- src/memberdef.cpp | 21 ++++++- src/memberdef.h | 2 + src/pagedef.cpp | 87 +++++++++++++++++++++++++- src/pagedef.h | 10 ++- src/scanner.l | 48 ++++++++++----- src/translator_cz.h | 131 ++++++++++++--------------------------- src/translator_kr.h | 2 +- src/translator_ru.h | 73 +++++----------------- src/translator_se.h | 58 +++++------------- src/util.cpp | 2 + src/xmldocvisitor.cpp | 15 +++++ src/xmlgen.cpp | 13 ++++ 33 files changed, 582 insertions(+), 532 deletions(-) diff --git a/INSTALL b/INSTALL index 31973d5..5584bcf 100644 --- a/INSTALL +++ b/INSTALL @@ -1,7 +1,7 @@ -DOXYGEN Version 1.4.1-20050307 +DOXYGEN Version 1.4.1-20050315 Please read the installation section of the manual (http://www.doxygen.org/install.html) for instructions. -------- -Dimitri van Heesch (07 March 2005) +Dimitri van Heesch (15 March 2005) diff --git a/README b/README index d644a75..6c51c4f 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -DOXYGEN Version 1.4.1_20050307 +DOXYGEN Version 1.4.1_20050315 Please read INSTALL for compilation instructions. @@ -17,4 +17,4 @@ to subscribe to the lists or to visit the archives. Enjoy, -Dimitri van Heesch (dimitri@stack.nl) (07 March 2005) +Dimitri van Heesch (dimitri@stack.nl) (15 March 2005) diff --git a/VERSION b/VERSION index d7b4e9a..b3b2265 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.4.1-20050307 +1.4.1-20050315 diff --git a/doc/commands.doc b/doc/commands.doc index 2c48ae5..391e4f7 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -137,6 +137,7 @@ documentation: \refitem cmdskip \\skip \refitem cmdskipline \\skipline \refitem cmdstruct \\struct +\refitem cmdsubpage \\subpage \refitem cmdsubsection \\subsection \refitem cmdsubsubsection \\subsubsection \refitem cmdtest \\test @@ -1323,6 +1324,58 @@ void memcpy(void *dest, const void *src, size_t n); Section \ref cmdpage "\\page" for an example of the \\ref command.
+\section cmdsubpage \\subpage ["(text)"] + + \addindex \\subpage + This command can be used to create a hierarchy of pages. The + same structure can be made using the \ref cmddefgroup "\\defgroup" and + \ref cmdingroup "\\ingroup" commands, but for pages the \\subpage command + is often more convenient. The main page (see \ref cmdmainpage "\\mainpage") + is typically the root of hierarchy. + + This command behaves similar as \ref cmdref "\\ref" in the sense that + it creates a reference to a page labeled \ with the optional + link text as specified in the second argument. + + It differs from the \\ref command in that it only works for pages, + and creates a parent-child relation between pages, where the + child page (or sub page) is identified by label \. + + See the \ref cmdsection "\\section" + and \ref cmdsubsection "\\subsection" commands if you want to add structure + without creating multiple pages. + + \note Each page can be the sub page of only one other page and + no cyclic relations are allowed, i.e. the page hierarchy must have a tree + structure. + + Here is an example: +\verbatim +/*! \mainpage A simple manual + +Some general info. + +This manual is divided in the following sections: +- \subpage intro +- \subpage advanced "Advanced usage" +*/ + +//----------------------------------------------------------- + +/*! \page intro Introduction +This page introduces the user to the topic. +Now you can proceed to the \ref advanced "advanced section". +*/ + +//----------------------------------------------------------- + +/*! \page advanced Advanced Usage +This page is for advanced users. +Make sure you have first read \ref intro "the introduction". +*/ +\endverbatim + +
\section cmdsection \\section (section title) \addindex \\section diff --git a/doc/grouping.doc b/doc/grouping.doc index 74656a6..2b896e5 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -16,11 +16,13 @@ */ /*! \page grouping Grouping -Doxygen has two mechanisms to group things together. +Doxygen has three mechanisms to group things together. One mechanism works at a global level, creating a new page -for each group. These groups are called "modules" in the documentation. -The other mechanism works within a member list of some compound entity, -and is refered to as a "member group". +for each group. These groups are called \ref modules "'modules'" in the documentation. +The second mechanism works within a member list of some compound entity, +and is refered to as a \ref memgroup "'member groups'". +For \ref cmdpage "pages" there is a third grouping mechanism referred to +a \ref subpaging "subpaging". \section modules Modules @@ -31,46 +33,53 @@ variables, enums, typedefs, and defines, but also other groups. To define a group, you should put the \ref cmddefgroup "\\defgroup" command in a special comment block. The first argument of the command -is a label that should uniquely identify the group. You can make an -entity a member of a specific group by putting +is a label that should uniquely identify the group. +The second argument is the name or title of the group as it should appear +in the documentation. + +You can make an entity a member of a specific group by putting a \ref cmdingroup "\\ingroup" command inside its documentation block. -The second argument is the title of the group. To avoid putting \ref cmdingroup "\\ingroup" commands in the documentation -of each member you can also group members together by the +for each member you can also group members together by the open marker \@{ before the group and the closing marker \@} after the group. The markers can be put in the documentation of the group definition or in a separate documentation block. -Groups can also be nested using these grouping markers. +Groups themselves can also be nested using these grouping markers. You will get an error message when you use the same group label more than once. -If you don't want doxygen to enforce -unique labels, then you can use \ref cmdaddtogroup "\\addtogroup" instead of -\ref cmddefgroup "\\defgroup". It can be used exactly like \ref cmddefgroup "\\defgroup", -but when the group has been defined already, then it silently merges the existing documentation -with the new one. +If you don't want doxygen to enforce unique labels, then you can +use \ref cmdaddtogroup "\\addtogroup" instead of +\ref cmddefgroup "\\defgroup". +It can be used exactly like \ref cmddefgroup "\\defgroup", +but when the group has been defined already, then it silently merges the +existing documentation with the new one. The title of the group is optional for this command, so you can use \verbatim /** \addtogroup