diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2008-05-18 11:56:00 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2008-05-18 11:56:00 (GMT) |
commit | 266542ab877882e802a3e189ca3f3535dd9e048a (patch) | |
tree | e85f15dbfa5b5c3a1d2eb4031c403ae367dd15a8 /doc | |
parent | b4f20f70abd663b3d8e5889e1fe582dfe980b7a2 (diff) | |
download | Doxygen-266542ab877882e802a3e189ca3f3535dd9e048a.zip Doxygen-266542ab877882e802a3e189ca3f3535dd9e048a.tar.gz Doxygen-266542ab877882e802a3e189ca3f3535dd9e048a.tar.bz2 |
Release-1.5.6
Diffstat (limited to 'doc')
-rw-r--r-- | doc/config.doc | 6 | ||||
-rw-r--r-- | doc/doxygen_manual.tex | 54 | ||||
-rw-r--r-- | doc/doxygen_usage.doc | 1 | ||||
-rw-r--r-- | doc/language.doc | 4 | ||||
-rw-r--r-- | doc/perlmod.doc | 5 | ||||
-rw-r--r-- | doc/translator_report.txt | 35 |
6 files changed, 42 insertions, 63 deletions
diff --git a/doc/config.doc b/doc/config.doc index c47e7bb..b0a4cb5 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -1358,6 +1358,12 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" with previous releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE respectively. + Via custom stylesheets (see \ref cfg_html_stylesheet "HTML_STYLESHEET") + one can further \ref doxygen_finetune "fine tune" the look of the index. + As an example, the default style sheet generated by doxygen has an + example that shows how to put an image at the root of the tree instead of + the \ref cfg_project_name "project name". + \anchor cfg_treeview_width <dt>\c TREEVIEW_WIDTH <dd> \addindex TREEVIEW_WIDTH diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index 9e8efb2..5a46eb9 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -46,34 +46,34 @@ Written by Dimitri van Heesch\\[2ex] \pagenumbering{arabic} \include{index} \part{User Manual} -\input{install} -\input{starting} -\input{docblocks} -\input{lists} -\input{grouping} -\input{formulas} -\input{diagrams} -\input{preprocessing} -\input{autolink} -\input{output} -\input{external} -\input{faq} -\input{trouble} +\chapter{Installation}\label{install}\hypertarget{install}{}\input{install} +\chapter{Getting Started}\label{starting}\hypertarget{starting}{}\input{starting} +\chapter{Documenting the code}\label{docblocks}\hypertarget{docblocks}{}\input{docblocks} +\chapter{Lists}\label{lists}\hypertarget{lists}{}\input{lists} +\chapter{Grouping}\label{grouping}\hypertarget{grouping}{}\input{grouping} +\chapter{Including Formulas}\label{formulas}\hypertarget{formulas}{}\input{formulas} +\chapter{Graphs and diagrams}\label{diagrams}\hypertarget{diagrams}{}\input{diagrams} +\chapter{Preprocessing}\label{preprocessing}\hypertarget{preprocessing}{}\input{preprocessing} +\chapter{Automatic link generation}\label{autolink}\hypertarget{autolink}{}\input{autolink} +\chapter{Output Formats}\label{output}\hypertarget{output}{}\input{output} +\chapter{Custom Commands}\label{custcmd}\hypertarget{custcmd}{}\input{custcmd} +\chapter{Link to external documentation}\label{external}\hypertarget{external}{}\input{external} +\chapter{Frequently Asked Questions}\label{faq}\hypertarget{faq}{}\input{faq} +\chapter{Troubleshootinh}\label{trouble}\hypertarget{trouble}{}\input{trouble} \part{Reference Manual} -\input{features} -\input{history} -\input{doxygen_usage} -\input{doxytag_usage} -\input{doxywizard_usage} -\input{installdox_usage} -\input{config} -\input{commands} -\input{htmlcmds} -\input{xmlcmds} +\chapter{Features}\label{features}\hypertarget{features}{}\input{features} +\chapter{Doxygen History}\label{history}\hypertarget{history}{}\input{history} +\chapter{Doxygen usage}\label{doxygen_usage}\hypertarget{doxygen_usage}{}\input{doxygen_usage} +\chapter{Doxytag usage}\label{doxytag_usage}\hypertarget{doxytag_usage}{}\input{doxytag_usage} +\chapter{Doxywizard usage}\label{doxywizard_usage}\hypertarget{doxywizard_usage}{}\input{doxywizard_usage} +\chapter{Installdox usage}\label{installdox_usage}\hypertarget{installdox_usage}{}\input{installdox_usage} +\chapter{Configuration}\label{config}\hypertarget{config}{}\input{config} +\chapter{Special Commands}\label{commands}\hypertarget{commands}{}\input{commands} +\chapter{HTML commands}\label{htmlcmds}\hypertarget{htmlcmds}{}\input{htmlcmds} +\chapter{XML commands}\label{xmlcmds}\hypertarget{xmlcmds}{}\input{xmlcmds} \part{Developers Manual} -\input{arch} -\input{perlmod} -%\input{perlmod_tree} -\input{langhowto} +\chapter{Doxygen's internals}\label{arch}\hypertarget{arch}{}\input{arch} +\chapter{Perl Module Output format}\label{perlmod}\hypertarget{perlmod}{}\input{perlmod} +\chapter{Internationalization}\label{langhowto}\hypertarget{langhowto}{}\input{langhowto} \printindex \end{document} diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index e74ae1b..3529e8d 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -54,6 +54,7 @@ to the new configuration file. Any new options will have their default value. Note that comments that you may have added in the original configuration file will be lost. +\anchor doxygen_finetune If you want to fine-tune the way the output looks, doxygen allows you generate default style sheet, header, and footer files that you can edit afterwards: diff --git a/doc/language.doc b/doc/language.doc index 9526b0b..62957ae 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -229,7 +229,7 @@ when the translator was updated. <td>Russian</td> <td>Alexandr Chelpanov</td> <td>cav at cryptopro dot ru</td> - <td>1.5.4</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Serbian</td> @@ -352,7 +352,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.5.4 \\ + Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & up-to-date \\ \hline Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & 1.4.1 \\ \hline diff --git a/doc/perlmod.doc b/doc/perlmod.doc index becbdf2..4a0ae91 100644 --- a/doc/perlmod.doc +++ b/doc/perlmod.doc @@ -168,10 +168,13 @@ tree. <p>As you can see, the documentation contained in <b>$doxydocs</b> does not present any special impediment to be processed by a simple -Perl script. To be able to generate meaningful output using the +Perl script. +<!-- +To be able to generate meaningful output using the documentation contained in <b>$doxydocs</b> you'll probably need to know the semantics of the nodes of the documentation tree, which we present in \ref perlmod_tree "this page". +--> \section doxymodel_format Data structure describing the Perl Module documentation tree. diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 1e0c1b9..c1311f7 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -9,7 +9,7 @@ German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. -Of them, 13 translators are up-to-date, 21 translators are based on +Of them, 14 translators are up-to-date, 20 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -30,6 +30,7 @@ still may be some details listed even for them: TranslatorItalian TranslatorKorean TranslatorPersian + TranslatorRussian TranslatorSpanish -- Change the base class to Translator. ---------------------------------------------------------------------- @@ -38,7 +39,6 @@ obsolete at the end). The other info shows the estimation of Doxygen version when the class was last updated and number of methods that must be implemented to become up-to-date: - TranslatorRussian 1.5.4 22 methods to implement TranslatorMacedonian 1.5.04 22 methods to implement Note: Change the base class to TranslatorAdapter_1_5_4. @@ -690,37 +690,6 @@ TranslatorRomanian (TranslatorAdapter_1_4_1) 24 methods to implement virtual QCString trNoDescriptionAvailable() -TranslatorRussian (TranslatorAdapter_1_5_4) 22 methods to implement ------------------ - - Implements 194 of the required methods. - - 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() - - TranslatorSerbian (TranslatorAdapter_1_4_1) 24 methods to implement ----------------- |