diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 53 | ||||
| -rw-r--r-- | doc/grouping.doc | 73 | ||||
| -rw-r--r-- | doc/index.doc | 2 | ||||
| -rw-r--r-- | doc/language.doc | 14 | ||||
| -rw-r--r-- | doc/lists.doc | 2 | ||||
| -rw-r--r-- | doc/translator_report.txt | 66 |
6 files changed, 116 insertions, 94 deletions
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. <hr> +\section cmdsubpage \\subpage <name> ["(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 \<name\> 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 \<name\>. + + 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 + +<hr> \section cmdsection \\section <section-name> (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 <code>\@{</code> before the group and the closing marker <code>\@}</code> 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 <label> */ /*\@{*/ /*\@}*/ \endverbatim -to add members to a group that is defined in more detail elsewhere. +to add additional members to a group that is defined in more detail elsewhere. Note that compound entities (like classes, files and namespaces) can be put into multiple groups, but members (like variable, functions, typedefs and enums) can only be a member of one group -(this restriction is to avoid ambiguous linking targets). - -Doxygen will put members into that group where the grouping definition had -the highest priority: f.i. \ref cmdingroup "\\ingroup" overrides any automatic -grouping definition via <code>\@{</code> <code>\@}</code>. Conflicting grouping -definitions with the same priority trigger a warning, unless one definition -was for a member without any explicit documentation. The following example -puts VarInA into group A and silently resolves the conflict for IntegerVariable by -putting it into group IntVariables, because the second instance of IntegerVariable +(this restriction is in place to avoid ambiguous linking targets in case +a member is not documented in the context of its class, namespace +or file, but only visible as part of a group). + +Doxygen will put members into the group whose definition has +the highest "priority": e.g. An explicit \ref cmdingroup "\\ingroup" overrides +an implicit grouping definition via <code>\@{</code> <code>\@}</code>. +Conflicting grouping definitions with the same priority trigger a warning, +unless one definition was for a member without any explicit documentation. + +The following example puts VarInA into group A and silently resolves +the conflict for IntegerVariable by putting it into group IntVariables, +because the second instance of IntegerVariable is undocumented: \verbatim @@ -192,4 +201,20 @@ Go to the <a href="formulas.html">next</a> section or return to the <a href="index.html">index</a>. \endhtmlonly +\section subpaging Subpaging + +Information can be grouped into pages using the \ref cmdpage "\\page" and +\ref cmdsubpage "\\mainpage" commands. Normally, this results in a +flat list of pages, where the "main" page is the first in the list. + +Instead of adding structure using the approach decribed in section +\ref modules "modules" it is often more natural and convienent to add +additional structure to the pages using the \ref cmdsubpage "\\subpage" +command. + +For a page A the \\subpage command adds a link to another page B and at +the same time makes page B a subpage of A. This has the effect of making +two groups GA and GB, where GB is part of GA, page A is put in group GA, +and page B is put in group GB. + */ diff --git a/doc/index.doc b/doc/index.doc index e678e1c..8abc2a0 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -27,7 +27,7 @@ Version: $(VERSION) <h2>Introduction</h2> Doxygen is a documentation system for C++, C, Java, Objective-C, IDL -(Corba and Microsoft flavors) and to some extent PHP, C# and D. +(Corba and Microsoft flavors) and to some extent PHP, C#, D, and ActionScript. It can help you in three ways: <ol> diff --git a/doc/language.doc b/doc/language.doc index 58b63a6..420b689 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -23,7 +23,7 @@ text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the configuration file (with default name and known as Doxyfile). -Currently (version 1.4.1-20050227), 30 languages +Currently (version 1.4.1-20050314), 30 languages are supported (sorted alphabetically): Afrikaans, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, @@ -90,7 +90,7 @@ when the translator was updated. <td>Czech</td> <td>Petr Přikryl</td> <td>prikrylp at skil dot cz</td> - <td>1.4.1</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Danish</td> @@ -204,7 +204,7 @@ when the translator was updated. <td>Russian</td> <td>Alexandr Chelpanov</td> <td>cav at cryptopro dot ru</td> - <td>1.4.1</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Serbian</td> @@ -234,7 +234,7 @@ when the translator was updated. <td>Swedish</td> <td>Mikael Hallin</td> <td>mikaelhallin at yahoo dot se</td> - <td>1.4.1</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Ukrainian</td> @@ -271,7 +271,7 @@ when the translator was updated. \hline Croatian & Boris Bralo & {\tt\tiny boris.bralo@zg.htnet.hr} & 1.4.1 \\ \hline - Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp@skil.cz} & 1.4.1 \\ + Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp@skil.cz} & up-to-date \\ \hline Danish & Erik S\o{}e S\o{}rensen & {\tt\tiny eriksoe+doxygen@daimi.au.dk} & 1.3.9 \\ \hline @@ -317,7 +317,7 @@ when the translator was updated. \hline Romanian & Alexandru Iosup & {\tt\tiny aiosup@yahoo.com} & 1.4.1 \\ \hline - Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & 1.4.1 \\ + Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & up-to-date \\ \hline Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & 1.4.1 \\ \hline @@ -327,7 +327,7 @@ when the translator was updated. \hline Spanish & Francisco Oltra Thennet & {\tt\tiny foltra@puc.cl} & 1.3.8 \\ \hline - Swedish & Mikael Hallin & {\tt\tiny mikaelhallin@yahoo.se} & 1.4.1 \\ + Swedish & Mikael Hallin & {\tt\tiny mikaelhallin@yahoo.se} & up-to-date \\ \hline Ukrainian & Olexij Tkatchenko & {\tt\tiny olexij.tkatchenko@parcs.de} & 1.4.1 \\ \hline diff --git a/doc/lists.doc b/doc/lists.doc index 84e0ac9..9da03d2 100644 --- a/doc/lists.doc +++ b/doc/lists.doc @@ -74,7 +74,7 @@ Here is an example that speaks for itself: If you like you can also use HTML commands inside the documentation blocks. Using these commands has the advantage that it is more natural -for list items that consists of multiple paragraphs. +for list items that consist of multiple paragraphs. Here is the above example with HTML commands: \verbatim diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 5e452b2..cbbb876 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,4 +1,4 @@ -(1.4.1-20050227) +(1.4.1-20050314) Doxygen supports the following 30 languages (sorted alphabetically): @@ -8,7 +8,7 @@ German, Greek, Hungarian, Italian, Japanese (+En), Korean (+En), Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. -Of them, 2 translators are up-to-date, 28 translators are based on +Of them, 5 translators are up-to-date, 25 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -17,8 +17,11 @@ alphabetically). This means that they derive from the Translator class and they implement all 192 of the required methods. Anyway, there still may be some details listed even for them: + TranslatorCzech TranslatorDutch -- Remove the obsolete methods (never used). TranslatorEnglish -- Remove the obsolete methods (never used). + TranslatorRussian + TranslatorSwedish ---------------------------------------------------------------------- The following translator classes need some maintenance (the most @@ -27,9 +30,7 @@ version when the class was last updated and number of methods that must be implemented to become up-to-date: TranslatorUkrainian 1.4.1 1 method to implement - TranslatorSwedish 1.4.1 1 method to implement TranslatorSerbian 1.4.1 1 method to implement - TranslatorRussian 1.4.1 1 method to implement TranslatorRomanian 1.4.1 1 method to implement TranslatorPolish 1.4.1 1 method to implement TranslatorKorean 1.4.01 1 method to implement @@ -39,7 +40,6 @@ must be implemented to become up-to-date: TranslatorHungarian 1.4.1 1 method to implement TranslatorGerman 1.4.1 1 method to implement TranslatorFrench 1.4.1 1 method to implement - TranslatorCzech 1.4.1 1 method to implement TranslatorCroatian 1.4.1 1 method to implement TranslatorChinese 1.4.1 1 method to implement TranslatorBrazilian 1.4.1 1 method to implement @@ -217,16 +217,6 @@ TranslatorCroatian (TranslatorAdapter_1_4_1) 1 method to implement virtual QCString trOverloadText() -TranslatorCzech (TranslatorAdapter_1_4_1) 1 method to implement ---------------- - - Implements 191 of the required methods. - - Missing methods (should be implemented): - - virtual QCString trOverloadText() - - TranslatorDanish (TranslatorAdapter_1_3_9) 7 methods to implement ---------------- @@ -769,29 +759,6 @@ TranslatorRomanian (TranslatorAdapter_1_4_1) 1 method to implement virtual QCString trNoDescriptionAvailable() -TranslatorRussian (TranslatorAdapter_1_4_1) 1 method to implement ------------------ - - Implements 191 of the required methods. - - Missing methods (should be implemented): - - virtual QCString trOverloadText() - - Obsolete methods (should be removed, never used): - - virtual QCString trHeaderFilesDescription() - virtual QCString trField(bool first_capital, bool singular) - virtual QCString trPackageDocumentation() - virtual QCString trSources() - virtual QCString trReimplementedForInternalReasons() - virtual QCString trInterfaces() - virtual QCString trHeaderFiles() - virtual QCString trBugsAndLimitations() - virtual QCString trEnumerationValueDocumentation() - virtual QCString trNoDescriptionAvailable() - - TranslatorSerbian (TranslatorAdapter_1_4_1) 1 method to implement ----------------- @@ -933,29 +900,6 @@ TranslatorSpanish (TranslatorAdapter_1_3_8) 8 methods to implement virtual QCString trNoDescriptionAvailable() -TranslatorSwedish (TranslatorAdapter_1_4_1) 1 method to implement ------------------ - - Implements 191 of the required methods. - - Missing methods (should be implemented): - - virtual QCString trOverloadText() - - Obsolete methods (should be removed, never used): - - virtual QCString trHeaderFilesDescription() - virtual QCString trField(bool first_capital, bool/*singular*/) - virtual QCString trPackageDocumentation() - virtual QCString trSources() - virtual QCString trReimplementedForInternalReasons() - virtual QCString trInterfaces() - virtual QCString trHeaderFiles() - virtual QCString trBugsAndLimitations() - virtual QCString trEnumerationValueDocumentation() - virtual QCString trNoDescriptionAvailable() - - TranslatorUkrainian (TranslatorAdapter_1_4_1) 1 method to implement ------------------- |