summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc15
-rw-r--r--doc/config.doc47
-rw-r--r--doc/doxywizard_usage.doc2
-rw-r--r--doc/language.doc8
-rw-r--r--doc/maintainers.txt2
-rw-r--r--doc/translator_report.txt142
6 files changed, 65 insertions, 151 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index e241e13..f61022a 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -54,7 +54,7 @@ documentation:
\refitem cmdcode \\code
\refitem cmdcond \\cond
\refitem cmdcopybrief \\copybrief
-\refitem cmdcopydefails \\copydetails
+\refitem cmdcopydetails \\copydetails
\refitem cmdcopydoc \\copydoc
\refitem cmddate \\date
\refitem cmddef \\def
@@ -152,6 +152,7 @@ documentation:
\refitem cmdtest \\test
\refitem cmdthrow \\throw
\refitem cmdtodo \\todo
+\refitem cmdtparam \\tparam
\refitem cmdtypedef \\typedef
\refitem cmdunion \\union
\refitem cmduntil \\until
@@ -1087,7 +1088,7 @@ ALIASES = "english=\if english" \
\addindex \\param
Starts a parameter description for a function parameter with name
- \<parameter-name\>. Followed by a description of the parameter.
+ \<parameter-name\>, followed by a description of the parameter.
The existence of the parameter is checked and a warning is given if
the documentation of this (or any other) parameter is missing or not
present in the function declaration or definition.
@@ -1117,6 +1118,16 @@ void memcpy(void *dest, const void *src, size_t n);
example.
<hr>
+\section cmdtparam \\tparam <template-parameter-name> { description }
+
+ \addindex \\tparam
+ Starts a template parameters for a class or function template parameter
+ with name \<template-parameter-name\>, followed by a description of the
+ template parameter.
+
+ Otherwise similar to \ref cmdparam "\\cmdparam".
+
+<hr>
\section cmdpost \\post { description of the postcondition }
\addindex \\post
diff --git a/doc/config.doc b/doc/config.doc
index 2e4f063..c47e7bb 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -113,6 +113,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_file_version_filter FILE_VERSION_FILTER
\refitem cfg_filter_patterns FILTER_PATTERNS
\refitem cfg_filter_source_files FILTER_SOURCE_FILES
+\refitem cfg_formula_fontsize FORMULA_FONTSIZE
\refitem cfg_full_path_names FULL_PATH_NAMES
\refitem cfg_generate_autogen_def GENERATE_AUTOGEN_DEF
\refitem cfg_generate_buglist GENERATE_BUGLIST
@@ -147,6 +148,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_html_header HTML_HEADER
\refitem cfg_html_output HTML_OUTPUT
\refitem cfg_html_stylesheet HTML_STYLESHEET
+\refitem cfg_idl_property_support IDL_PROPERTY_SUPPORT
\refitem cfg_ignore_prefix IGNORE_PREFIX
\refitem cfg_image_path IMAGE_PATH
\refitem cfg_include_graph INCLUDE_GRAPH
@@ -445,6 +447,16 @@ followed by the descriptions of the tags grouped by category.
Doxygen will parse them like normal C++ but will assume all classes use public
instead of private inheritance when no explicit protection keyword is present.
+\anchor cfg_idl_property_support
+<dt>\c IDL_PROPERTY_SUPPORT <dd>
+ \addindex IDL_PROPERTY_SUPPORT
+ For Microsoft's IDL there are propget and propput attributes to indicate getter
+ and setter methods for a property. Setting this option to \c YES (the default)
+ will make doxygen to replace the get and set methods by a property in the
+ documentation. This will only work if the methods are indeed getting or
+ setting a simple type. If this is not the case, or you want to show the
+ methods anyway, you should set this option to \c NO.
+
\anchor cfg_distribute_group_doc
<dt>\c DISTRIBUTE_GROUP_DOC <dd>
\addindex DISTRIBUTE_GROUP_DOC
@@ -1038,14 +1050,14 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
\anchor cfg_referenced_by_relation
<dt>\c REFERENCED_BY_RELATION <dd>
\addindex REFERENCED_BY_RELATION
- If the \c REFERENCED_BY_RELATION tag is set to \c YES (the default)
+ If the \c REFERENCED_BY_RELATION tag is set to \c YES
then for each documented function all documented
functions referencing it will be listed.
\anchor cfg_references_relation
<dt>\c REFERENCES_RELATION <dd>
\addindex REFERENCES_RELATION
- If the \c REFERENCES_RELATION tag is set to \c YES (the default)
+ If the \c REFERENCES_RELATION tag is set to \c YES
then for each documented function all documented entities
called/used by that function will be listed.
@@ -1353,6 +1365,15 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
used to set the initial width (in pixels) of the frame in which the tree
is shown.
+\anchor cfg_formula_fontsize
+<dt>\c FORMULA_FONTSIZE <dd>
+ \addindex FORMULA_FONTSIZE
+ Use this tag to change the font size of Latex formulas included
+ as images in the HTML documentation. The default is 10.
+ when you change the font size after a successful doxygen run you need
+ to manually remove any <code>form_*.png</code> images from the HTML
+ output directory to force them to be regenerated.
+
</dl>
\section latex_output LaTeX related options
\anchor cfg_generate_latex
@@ -1815,6 +1836,26 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
<a href="http://www.research.att.com/sw/tools/graphviz/">Graphviz</a>, a graph
visualization toolkit from AT\&T and Lucent Bell Labs. The other options in
this section have no effect if this option is set to \c NO (the default)
+
+\anchor cfg_dot_fontname
+<dt>\c DOT_FONTNAME <dd>
+ \addindex DOT_FONTNAME
+ By default doxygen will write a font called \c FreeSans.ttf to the output
+ directory and reference it in all dot files that doxygen generates. This
+ font does not include all possible unicode characters however, so when you need
+ these (or just want a differently looking font) you can specify the font name
+ using \c DOT_FONTNAME. You need need to make sure dot is able to find the font,
+ which can be done by putting it in a standard location or by setting the
+ \c DOTFONTPATH environment variable or by setting \c DOT_FONTPATH to the directory
+ containing the font.
+
+\anchor cfg_dot_fontpath
+<dt>\c DOT_FONTPATH <dd>
+ \addindex DOT_FONTPATH
+ By default doxygen will tell dot to use the output directory to look for the
+ \c FreeSans.ttf font (which doxygen will put there itself). If you specify a
+ different font using \c DOT_FONTNAME you can set the path where dot
+ can find it using this tag.
<dt>\c DOT_FONTNAME <dd>
\addindex DOT_FONTNAME
@@ -1927,7 +1968,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
\anchor cfg_dot_graph_max_nodes
<dt>\c DOT_GRAPH_MAX_NODES <dd>
\addindex DOT_GRAPH_MAX_NODES
- The \c MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+ The \c DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
nodes that will be shown in the graph. If the number of nodes in a graph
becomes larger than this value, doxygen will truncate the graph, which is
visualized by representing a node as a red box. Note that doxygen if the number
diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc
index 1980bb5..13bbfb1 100644
--- a/doc/doxywizard_usage.doc
+++ b/doc/doxywizard_usage.doc
@@ -81,7 +81,7 @@ produce. For HTML and LaTeX there are additional options.
Doxygen can produce a number of diagrams. Using the diagrams tab you
can select which ones to generate. For most diagrams the
dot tool of the <a href="http://www.graphviz.org">GraphViz</a> package
-is needed (if you use the binary packages for Mac or Windows this
+is needed (if you use the binary packages for MacOSX this
tool is already included).
<h3>Expert dialog</h3>
diff --git a/doc/language.doc b/doc/language.doc
index 8a16c32..9526b0b 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -119,9 +119,9 @@ when the translator was updated.
</tr>
<tr bgcolor="#ffffff">
<td>Finnish</td>
- <td>Olli Korhonen</td>
- <td>olli.korhonen lost at cyberspace</td>
- <td>obsolete</td>
+ <td>Antti Laine</td>
+ <td>antti.a.laine at tut dot fi</td>
+ <td>up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>French</td>
@@ -307,7 +307,7 @@ when the translator was updated.
\hline
English & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\
\hline
- Finnish & Olli Korhonen & {\tt\tiny olli.korhonen lost@cyberspace} & obsolete \\
+ Finnish & Antti Laine & {\tt\tiny antti.a.laine@tut.fi} & up-to-date \\
\hline
French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & 1.5.4 \\
\hline
diff --git a/doc/maintainers.txt b/doc/maintainers.txt
index dff66d7..b90bd8e 100644
--- a/doc/maintainers.txt
+++ b/doc/maintainers.txt
@@ -46,7 +46,7 @@ TranslatorEnglish
Dimitri van Heesch: dimitri@stack.nl
TranslatorFinnish
-Olli Korhonen: olli.korhonen lost@cyberspace
+Antti Laine: antti.a.laine@tut.fi
TranslatorFrench
Xavier Outhier: xouthier@yahoo.fr
diff --git a/doc/translator_report.txt b/doc/translator_report.txt
index ebbe39a..1e0c1b9 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, 12 translators are up-to-date, 22 translators are based on
+Of them, 13 translators are up-to-date, 21 translators are based on
some adapter class, and 2 are English based.
----------------------------------------------------------------------
@@ -25,6 +25,7 @@ still may be some details listed even for them:
TranslatorCzech
TranslatorDutch
TranslatorEnglish
+ TranslatorFinnish
TranslatorGerman
TranslatorItalian
TranslatorKorean
@@ -60,7 +61,6 @@ must be implemented to become up-to-date:
TranslatorRomanian 1.4.1 24 methods to implement
TranslatorPortuguese 1.3.3 35 methods to implement
TranslatorSlovak 1.2.18 44 methods to implement
- TranslatorFinnish obsolete 118 methods to implement
----------------------------------------------------------------------
The following translator classes derive directly from the
@@ -215,144 +215,6 @@ TranslatorDanish (TranslatorAdapter_1_5_4) 22 methods to implement
virtual QCString trSubprogramDocumentation()
-TranslatorFinnish (TranslatorEnglish) 118 methods to implement
------------------
-
- Implements 98 of the required methods.
-
- Missing methods (should be implemented):
-
- virtual QCString trPublicAttribs()
- virtual QCString trPropertyDocumentation()
- virtual QCString trMember(bool first_capital, bool singular)
- virtual QCString trPageIndex()
- virtual QCString trCompoundMembersDescriptionFortran(bool extractAll)
- virtual QCString trOverloadText()
- virtual QCString trSince()
- virtual QCString trEventDocumentation()
- virtual QCString trDirIndex()
- virtual QCString trRemarks()
- virtual QCString trProtectedTypes()
- virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single)
- virtual QCString trFile(bool first_capital, bool singular)
- virtual QCString trPackages()
- virtual QCString trInclByDepGraph()
- virtual QCString trRTFansicp()
- virtual QCString trImplementedFromList(int numEntries)
- virtual QCString trSubprograms()
- virtual QCString trCollaborationDiagram(const char * clName)
- virtual QCString trPackageListDescription()
- virtual QCString trDefineValue()
- virtual QCString trPackageMembers()
- virtual QCString trStaticPackageMembers()
- virtual QCString trModulesListDescription(bool extractAll)
- virtual QCString trModulesList()
- virtual QCString trDirDocumentation()
- virtual QCString trPackage(const char * name)
- virtual QCString trPublicTypes()
- virtual QCString trSearchResultsTitle()
- virtual QCString trDirectories()
- virtual QCString trTest()
- virtual QCString trTypeConstraints()
- virtual QCString trInvariant()
- virtual QCString trDeprecatedList()
- virtual QCString trGraphicalHierarchy()
- virtual QCString trPostcondition()
- virtual QCString trGotoGraphicalHierarchy()
- virtual QCString trPageAbbreviation()
- virtual QCString trMemberFunctionDocumentationFortran()
- virtual QCString trDirDescription()
- virtual QCString trGotoSourceCode()
- virtual QCString trStaticPackageAttribs()
- virtual QCString trCompoundListDescriptionFortran()
- virtual QCString trCallGraph()
- virtual QCString trStaticPublicAttribs()
- virtual QCString trCode()
- virtual QCString trTodo()
- virtual QCString trTypeDocumentation()
- virtual QCString trModuleReference(const char * namespaceName)
- virtual QCString trModulesMemberDescription(bool extractAll)
- virtual QCString trRTFCharSet()
- virtual QCString trModulesMembers()
- virtual QCString trInitialValue()
- virtual QCString trAlphabeticalList()
- virtual QCString trBug()
- virtual QCString trNote()
- virtual QCString trStaticPrivateAttribs()
- virtual QCString trAttention()
- virtual QCString trGotoTextualHierarchy()
- virtual QCString trModulesIndex()
- virtual QCString trPackageTypes()
- virtual QCString trMainPage()
- virtual QCString trDeprecated()
- virtual QCString trCompoundListFortran()
- virtual QCString trClass(bool first_capital, bool singular)
- virtual QCString trImplementedInList(int numEntries)
- virtual QCString trPrivateTypes()
- virtual QCString trDataTypes()
- virtual QCString trInclDepGraph(const char * fName)
- virtual QCString trSearchResults(int numDocuments)
- virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType, bool single)
- virtual QCString trNamespaces()
- virtual QCString trPrivateAttribs()
- virtual QCString idLanguageCharset()
- virtual QCString trDefinedInSourceFile()
- virtual QCString trConstructorDocumentation()
- virtual QCString trLegend()
- virtual QCString trPackageAttribs()
- virtual QCString trSearchMatches()
- virtual QCString trClasses()
- virtual QCString trProtectedAttribs()
- virtual QCString trLegendTitle()
- virtual QCString trCompoundIndexFortran()
- virtual QCString trSubprogram(bool first_capital, bool singular)
- virtual QCString trEvents()
- virtual QCString trGlobal(bool first_capital, bool singular)
- virtual QCString trDCOPMethods()
- virtual QCString latexLanguageSupportCommand()
- virtual QCString trBugList()
- virtual QCString trRTFGeneralIndex()
- virtual QCString trCallerGraph()
- virtual QCString trNamespace(bool first_capital, bool singular)
- virtual QCString trTestList()
- virtual QCString trPrecondition()
- virtual QCString trCompoundReferenceFortran(const char * clName, ClassDef::CompoundType compType, bool isTemplate)
- virtual QCString trReturnValues()
- virtual QCString trReferences()
- virtual QCString trType(bool first_capital, bool singular)
- virtual QCString trAuthor(bool first_capital, bool singular)
- virtual QCString trLegendDocs()
- virtual QCString trModule(bool first_capital, bool singular)
- virtual QCString trPackageList()
- virtual QCString trTodoList()
- virtual QCString trPage(bool first_capital, bool singular)
- virtual QCString trCompoundMembersFortran()
- virtual QCString trSourceFile(QCString & filename)
- virtual QCString trGotoDocumentation()
- virtual QCString trDefinedAtLineInSourceFile()
- virtual QCString trDirReference(const char * dirName)
- virtual QCString trDir(bool first_capital, bool singular)
- virtual QCString trSearchForIndex()
- virtual QCString trAll()
- virtual QCString trSubprogramDocumentation()
- virtual QCString trRTFTableOfContents()
- virtual QCString trGroup(bool first_capital, bool singular)
- virtual QCString trReferencedBy()
- virtual QCString trStaticProtectedAttribs()
- virtual QCString trProperties()
-
- Obsolete methods (should be removed, never used):
-
- QCString trHeaderFilesDescription()
- QCString trReimplementedForInternalReasons()
- QCString trFiles()
- virtual QCString updateNeededMessage()
- QCString trHeaderFiles()
- QCString trAuthors()
- QCString trBugsAndLimitations()
- QCString trNoDescriptionAvailable()
-
-
TranslatorFrench (TranslatorAdapter_1_5_4) 22 methods to implement
----------------