diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/autolink.doc | 5 | ||||
| -rw-r--r-- | doc/commands.doc | 15 | ||||
| -rw-r--r-- | doc/customize.doc | 6 | ||||
| -rw-r--r-- | doc/language.doc | 4 | ||||
| -rw-r--r-- | doc/translator_report.txt | 33 |
5 files changed, 29 insertions, 34 deletions
diff --git a/doc/autolink.doc b/doc/autolink.doc index 96ce3bc..767fb5f 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -38,11 +38,12 @@ \section linkclass Links to classes. All words in the documentation that correspond to a documented class and - contain at least one upper case character will automatically be replaced by - a link to the page containing the + contain at least one non-lower case character will automatically be + replaced by a link to the page containing the documentation of the class. If you want to prevent that a word that corresponds to a documented class is replaced by a link you should put a \% in front of the word. + To link to an all lower case symbol, use \ref cmdref "\\ref". \section linkfile Links to files. diff --git a/doc/commands.doc b/doc/commands.doc index 43948a4..b56ebf3 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -176,6 +176,7 @@ documentation: \refitem cmdgt \\\> \refitem cmdhash \\\# \refitem cmdperc \\\% +\refitem cmdquot \\\" \endsecreflist The following subsections provide a list of all commands that are recognized by @@ -224,6 +225,7 @@ Structural indicators \sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup" and \ref cmdweakgroup "\\weakgroup". +<hr> \section cmdcallgraph \\callgraph \addindex \\callgraph @@ -324,7 +326,6 @@ Structural indicators stripped from the full path before it appears in the output. <hr> - \section cmdenum \\enum <name> \addindex \\enum @@ -884,6 +885,7 @@ Section indicators The \\attention command ends when a blank line or some other sectioning command is encountered. +<hr> \section cmdauthor \\author { list of authors } \addindex \\author @@ -1423,6 +1425,7 @@ void memcpy(void *dest, const void *src, size_t n); sectioning command is encountered. See section \ref cmdauthor "\\author" for an example. +<hr> \section cmdxrefitem \\xrefitem <key> "(heading)" "(list title)" {text} \addindex \\xrefitem @@ -1465,6 +1468,7 @@ Commands to create links </h2> \htmlonly </center>\endhtmlonly +<hr> \section cmdaddindex \\addindex (text) \addindex \\addindex @@ -1644,6 +1648,7 @@ Commands for displaying examples </h2> \htmlonly </center>\endhtmlonly +<hr> \section cmddontinclude \\dontinclude <file-name> \addindex \\dontinclude @@ -2453,6 +2458,7 @@ class Receiver This command writes the \> character to the output. This character has to be escaped because it has a special meaning in HTML. +<hr> \section cmdperc \\\% \addindex \\\% @@ -2461,7 +2467,14 @@ class Receiver prevent auto-linking to word that is also a documented class or struct. <hr> +\section cmdquot \\\" + \addindex \\\" + This command writes the \" character to the output. This + character has to be escaped in some cases, because it is used to + prevent auto-linking to word that is also a documented class or struct. + +<hr> \htmlonly <center> \endhtmlonly <h2> \htmlonly --- \endhtmlonly diff --git a/doc/customize.doc b/doc/customize.doc index d840484..40ef398 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -87,6 +87,12 @@ doxygen -l optionally the name of the layout file can be specified, if omitted \c DoxygenLayout.xml will be used. +The next step is to mention the layout file in the config file +\verbatim +LAYOUT_FILE = DoxygenLayout.xml +\endverbatim +The change the layout all you need to do is edit the layout file. + The toplevel structure of the file looks as follows: \verbatim <doxygenlayout version="1.0"> diff --git a/doc/language.doc b/doc/language.doc index 4494aad..3dbd686 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -134,7 +134,7 @@ when the translator was updated. <td>French</td> <td>Xavier Outhier</td> <td>xouthier at yahoo dot fr</td> - <td>1.5.4</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>German</td> @@ -336,7 +336,7 @@ when the translator was updated. \hline Finnish & Antti Laine & {\tt\tiny antti.a.laine@tut.fi} & 1.6.0 \\ \hline - French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & 1.5.4 \\ + French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & up-to-date \\ \hline German & Jens Seidel & {\tt\tiny jensseidel@users.sf.net} & 1.6.0 \\ \hline diff --git a/doc/translator_report.txt b/doc/translator_report.txt index f3f12e0..bca0e8e 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -10,7 +10,7 @@ Persian, Polish, Portuguese, Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese. -Of them, 5 translators are up-to-date, 33 translators are based on +Of them, 6 translators are up-to-date, 32 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -22,6 +22,7 @@ still may be some details listed even for them: TranslatorCzech TranslatorDutch TranslatorEnglish + TranslatorFrench -- The MAX_DOT_GRAPH_HEIGHT found in trLegendDocs() TranslatorKorean TranslatorPolish -- Remove the obsolete methods (never used). @@ -53,7 +54,6 @@ must be implemented to become up-to-date: TranslatorBrazilian 1.6.0 5 methods to implement (2 %) TranslatorAfrikaans 1.6.0 5 methods to implement (2 %) TranslatorGreek 1.5.4 27 methods to implement (12 %) - TranslatorFrench 1.5.4 22 methods to implement (9 %) TranslatorDanish 1.5.4 27 methods to implement (12 %) TranslatorSlovene 1.4.6 29 methods to implement (13 %) TranslatorNorwegian 1.4.6 28 methods to implement (12 %) @@ -288,35 +288,10 @@ TranslatorFinnish (TranslatorAdapter_1_6_0) 5 methods to implement (2 %) virtual QCString trDirRelation(const char * name) -TranslatorFrench (TranslatorAdapter_1_5_4) 22 methods to implement (9 %) +TranslatorFrench (Translator) ---------------- - Implements 199 of the required methods (90 %). - - Missing methods (should be implemented): - - virtual QCString trCompoundMembersDescriptionFortran(bool extractAll) - virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single) - virtual QCString trSubprograms() - virtual QCString trModulesListDescription(bool extractAll) - virtual QCString trModulesList() - virtual QCString trTypeConstraints() - virtual QCString trMemberFunctionDocumentationFortran() - virtual QCString trCompoundListDescriptionFortran() - virtual QCString trTypeDocumentation() - virtual QCString trModuleReference(const char * namespaceName) - virtual QCString trModulesMemberDescription(bool extractAll) - virtual QCString trModulesMembers() - virtual QCString trModulesIndex() - virtual QCString trCompoundListFortran() - virtual QCString trDataTypes() - virtual QCString trCompoundIndexFortran() - virtual QCString trSubprogram(bool first_capital, bool singular) - virtual QCString trCompoundReferenceFortran(const char * clName, ClassDef::CompoundType compType, bool isTemplate) - virtual QCString trType(bool first_capital, bool singular) - virtual QCString trModule(bool first_capital, bool singular) - virtual QCString trCompoundMembersFortran() - virtual QCString trSubprogramDocumentation() + Implements 221 of the required methods (100 %). TranslatorGerman (TranslatorAdapter_1_6_0) 5 methods to implement (2 %) |