diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/diagrams.doc | 2 | ||||
| -rw-r--r-- | doc/docblocks.doc | 5 | ||||
| -rw-r--r-- | doc/doxygen.sty | 14 | ||||
| -rw-r--r-- | doc/doxygen_manual.tex | 1 | ||||
| -rw-r--r-- | doc/htmlcmds.doc | 68 | ||||
| -rw-r--r-- | doc/index.doc | 1 | ||||
| -rw-r--r-- | doc/language.doc | 6 | ||||
| -rw-r--r-- | doc/markdown.doc | 31 | ||||
| -rw-r--r-- | doc/translator_report.txt | 26 |
10 files changed, 123 insertions, 33 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index 0d1381e..1b0a311 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -34,7 +34,7 @@ ENABLE_PREPROCESSING = NO CASE_SENSE_NAMES = NO IMAGE_PATH = . INPUT = index.doc install.doc starting.doc docblocks.doc markdown.doc \ - grouping.doc formulas.doc diagrams.doc preprocessing.doc \ + lists.doc grouping.doc formulas.doc diagrams.doc preprocessing.doc \ autolink.doc output.doc searching.doc customize.doc custcmd.doc \ external.doc faq.doc trouble.doc features.doc \ doxygen_usage.doc doxywizard_usage.doc \ diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 7d488fa..56f82b8 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -136,7 +136,7 @@ that doxygen can generate: \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/diagrams/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen<br/> - (<code>EXTRACT_ALL</code> = <code>YES</code> is used here). + (<code>EXTRACT_ALL</code> = <code>YES</code> is used here).<p> \endhtmlonly \htmlonly diff --git a/doc/docblocks.doc b/doc/docblocks.doc index facd1b5..d6bb675 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -597,4 +597,9 @@ forms of additional markup on top of Markdown formatting. If this is still not enough doxygen also supports a \ref htmlcmds "subset" of the <a href="http://en.wikipedia.org/wiki/HTML">HTML</a> markup language. +\htmlonly +Go to the <a href="markdown.html">next</a> section or return to the + <a href="index.html">index</a>. +\endhtmlonly + */ diff --git a/doc/doxygen.sty b/doc/doxygen.sty index c64fb09..45bec34 100644 --- a/doc/doxygen.sty +++ b/doc/doxygen.sty @@ -10,6 +10,8 @@ \RequirePackage{longtable} \RequirePackage{verbatim} \RequirePackage{ifthen} +\RequirePackage{xtab} +\RequirePackage{multirow} \RequirePackage[table]{xcolor} % Use helvetica font instead of times roman @@ -95,11 +97,11 @@ % Used by @code ... @endcode \newenvironment{DoxyCode}{% - \footnotesize% - \verbatim% + + +\begin{scriptsize}\begin{alltt}% }{% - \endverbatim% - \normalsize% +\end{alltt}\end{scriptsize}% } % Used by @example, @include, @includelineno and @dontinclude @@ -402,10 +404,10 @@ { \setlength{\tmplength} {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)} - \par\begin{tabular*}{\linewidth} + \par\begin{xtabular*}{\linewidth} {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|} } -{\end{tabular*}\par} +{\end{xtabular*}\par} \newcommand{\entrylabel}[1]{ {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{% \usefont{OT1}{phv}{bc}{n}\color{darkgray}#1}\vspace{1.5\baselineskip}}}} diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index 8e47015..1c9ad2a 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -49,6 +49,7 @@ \usepackage{courier} \usepackage{sectsty} \usepackage[titles]{tocloft} +\usepackage{amssymb} \usepackage{doxygen} \lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left } \makeindex diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 7b3ff71..d4af0f9 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -141,6 +141,73 @@ The special HTML character entities that are recognized by Doxygen: <li><tt>\&?ring;</tt> where ? is one of {a,A}, writes an <tt>a</tt> with a ring (like å). <li><tt>\ </tt> a non breakable space. +<li><tt>\Γ</tt> Greek letter Gamma Γ. +<li><tt>\Δ</tt> Greek letter Delta Δ. +<li><tt>\Θ</tt> Greek letter Theta Θ. +<li><tt>\Λ</tt> Greek letter Lambda Λ. +<li><tt>\Ξ</tt> Greek letter Xi Ξ. +<li><tt>\Π</tt> Greek letter Pi Π. +<li><tt>\Σ</tt> Greek letter Sigma Σ. +<li><tt>\Υ</tt> Greek letter Upsilon Υ. +<li><tt>\Φ</tt> Greek letter Phi Φ. +<li><tt>\Ψ</tt> Greek letter Psi Ψ. +<li><tt>\Ω</tt> Greek letter Omega Ω. +<li><tt>\α</tt> Greek letter alpha α. +<li><tt>\β</tt> Greek letter beta β. +<li><tt>\γ</tt> Greek letter gamma γ. +<li><tt>\δ</tt> Greek letter delta δ. +<li><tt>\ε</tt> Greek letter epsilon ε. +<li><tt>\ζ</tt> Greek letter zeta ζ. +<li><tt>\η</tt> Greek letter eta η. +<li><tt>\θ</tt> Greek letter theta θ. +<li><tt>\ι</tt> Greek letter iota ι. +<li><tt>\κ</tt> Greek letter kappa κ. +<li><tt>\λ</tt> Greek letter lambda λ. +<li><tt>\μ</tt> Greek letter mu μ. +<li><tt>\ν</tt> Greek letter nu ν. +<li><tt>\ξ</tt> Greek letter xi ξ. +<li><tt>\π</tt> Greek letter pi π. +<li><tt>\ρ</tt> Greek letter rho ρ. +<li><tt>\σ</tt> Greek letter sigma σ. +<li><tt>\τ</tt> Greek letter tau τ. +<li><tt>\υ</tt> Greek letter upsilon υ. +<li><tt>\φ</tt> Greek letter phi φ. +<li><tt>\χ</tt> Greek letter chi χ. +<li><tt>\ψ</tt> Greek letter psi ψ. +<li><tt>\ω</tt> Greek letter omega ω. +<li><tt>\ς</tt> Greek final sigma ς. +<li><tt>\§</tt> section sign §. +<li><tt>\°</tt> degree °. +<li><tt>\′</tt> prime ′. +<li><tt>\″</tt> double prime ″. +<li><tt>\∞</tt> infinity ∞. +<li><tt>\∅</tt> empty set ∅. +<li><tt>\±</tt> plus or minus ±. +<li><tt>\×</tt> multiplication sign ×. +<li><tt>\−</tt> minus sign −. +<li><tt>\⋅</tt> centered dot ⋅. +<li><tt>\∂</tt> partial derivative ∂. +<li><tt>\∇</tt> nabla symbol ∇. +<li><tt>\√</tt> square root √. +<li><tt>\⊥</tt> perpendicular symbol ⊥. +<li><tt>\∑</tt> sum ∑. +<li><tt>\∫</tt> integral ∫. +<li><tt>\∏</tt> product ∏. +<li><tt>\∼</tt> similar to ∼. +<li><tt>\≈</tt> approximately equal to ≈. +<li><tt>\≠</tt> not equal to ≠. +<li><tt>\≡</tt> equivalent to ≡. +<li><tt>\∝</tt> proportional to ∝. +<li><tt>\≤</tt> less than or equal to ≤. +<li><tt>\≥</tt> greater than or equal to ≥. +<li><tt>\←</tt> left arrow ←. +<li><tt>\→</tt> right arrow →. +<li><tt>\∈</tt> in the set ∈. +<li><tt>\∉</tt> not in the set ∉. +<li><tt>\⌈</tt> left ceiling sign ⌈. +<li><tt>\⌉</tt> right ceiling sign ⌉. +<li><tt>\⌊</tt> left floor sign ⌊. +<li><tt>\⌋</tt> right floor sign ⌋. </ul> Finally, to put invisible comments inside comment blocks, HTML style @@ -150,4 +217,3 @@ comments can be used: \endverbatim */ - diff --git a/doc/index.doc b/doc/index.doc index e604ee5..5207b37 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -66,6 +66,7 @@ The first part forms a user manual: <li>Section \ref docblocks demonstrates the various ways that code can be documented. <li>Section \ref markdown show the Markdown formatting supported by doxygen. +<li>Section \ref lists shows how to create lists. <li>Section \ref grouping shows how to group things together. <li>Section \ref formulas shows how to insert formulas in the documentation. <li>Section \ref diagrams describes the diagrams and graphs that doxygen can generate. diff --git a/doc/language.doc b/doc/language.doc index 4f9a35b..ce72f23 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.8.1), 39 languages +Currently (version 1.8.1.1), 39 languages are supported (sorted alphabetically): Afrikaans, Arabic, Armenian, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, @@ -188,7 +188,7 @@ when the translator was updated. <td>Korean</td> <td>Kim Taedong<br/>SooYoung Jung<br/>Richard Kim</td> <td>fly1004 at gmail dot com<br/>jung5000 at gmail dot com<br/><span style="color: brown">[unreachable]</span></td> - <td>1.7.5</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>KoreanEn</td> @@ -371,7 +371,7 @@ when the translator was updated. \hline JapaneseEn & see the Japanese language & {\tt\tiny ~} & English based \\ \hline - Korean & Kim Taedong & {\tt\tiny fly1004 at gmail dot com} & 1.7.5 \\ + Korean & Kim Taedong & {\tt\tiny fly1004 at gmail dot com} & up-to-date \\ ~ & SooYoung Jung & {\tt\tiny jung5000 at gmail dot com} & ~ \\ ~ & Richard Kim & {\tt\tiny [unreachable] ryk at dspwiz dot com} & ~ \\ \hline diff --git a/doc/markdown.doc b/doc/markdown.doc index 8bb972e..4df3efc 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -124,6 +124,8 @@ You can also make a numbered list like so 1. First item. 2. Second item. +Make sure to also read \ref mddox_lists for doxygen specifics. + \subsection md_codeblock Code Blocks Preformatted verbatim blocks can be created by indenting @@ -546,6 +548,30 @@ Example: 1. Item1 of list 2 2. Item2 of list 2 +With Markdown the actual numbers you use to mark the list have no +effect on the HTML output Markdown produces. I.e. it treats the +following as a list with 3 numbered items: + + 1. Item1 + 1. Item2 + 1. Item3 + +Doxygen however requires that the numbers used as marks are in +strictly ascending order; an item with a equal or lower number than +the preceding item, will start a new list. For example: + + 1. Item1 of list 1 + 3. Item2 of list 1 + 2. Item1 of list 2 + 4. Item2 of list 2 + +will produce: + +1. Item1 of list 1 +3. Item2 of list 1 +2. Item1 of list 2 +4. Item2 of list 2 + Historically doxygen has an additional way to create numbered lists by using `-#` markers: @@ -603,4 +629,9 @@ To see the result after Markdown processing you can run doxygen with the `-d Markdown` option. It will then print each comment block before and after Markdown processing. +\htmlonly +Go to the <a href="lists.html">next</a> section or return to the + <a href="index.html">index</a>. +\endhtmlonly + */ diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 6911d6f..060fd30 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,4 +1,4 @@ -(1.8.1) +(1.8.1.1) Doxygen supports the following 39 languages (sorted alphabetically): @@ -10,7 +10,7 @@ Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese. -Of them, 11 translators are up-to-date, 28 translators are based on +Of them, 12 translators are up-to-date, 27 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -27,6 +27,7 @@ still may be some details listed even for them: TranslatorEsperanto TranslatorGerman TranslatorItalian + TranslatorKorean -- Change the base class to Translator. TranslatorPolish -- Remove the obsolete methods (never used). TranslatorSlovak TranslatorSpanish -- The MAX_DOT_GRAPH_HEIGHT found in trLegendDocs() @@ -59,9 +60,6 @@ must be implemented to become up-to-date: Note: Reimplementation using UTF-8 suggested. TranslatorPersian 1.7.5 10 methods to implement (4 %) - TranslatorKorean 1.7.5 10 methods to implement (4 %) - Note: Reimplementation using UTF-8 suggested. - TranslatorVietnamese 1.6.0 19 methods to implement (8 %) TranslatorSwedish 1.6.0 19 methods to implement (8 %) Note: Reimplementation using UTF-8 suggested. @@ -122,7 +120,6 @@ for occurence of the method identifiers: QCString trDirDependency(const char *) QCString trFuncProtos() QCString trFunctionPrototypeDocumentation() - QCString trGraphicalHierarchy() QCString trSearchForIndex() @@ -484,23 +481,10 @@ TranslatorJapaneseEn (TranslatorEnglish) 230 methods to implement (97 %) virtual QCString latexLanguageSupportCommand() -TranslatorKorean (TranslatorAdapter_1_7_5) 10 methods to implement (4 %) +TranslatorKorean (TranslatorAdapter_1_7_5) ---------------- - Implements 225 of the required methods (95 %). - - Missing methods (should be implemented): - - virtual QCString trDetailLevel() - virtual QCString trTemplateParameters() - virtual QCString trAndMore(const QCString & number) - virtual QCString trDirDepGraph(const char * name) - virtual QCString trEnumReference(const char * name) - virtual QCString trInheritedFrom(const char * members, const char * what) - virtual QCString trCiteReferences() - virtual QCString trAdditionalInheritedMembers() - virtual QCString trCopyright() - virtual QCString trEnumGeneratedFromFiles(bool single) + Implements 235 of the required methods (100 %). TranslatorKoreanEn (TranslatorEnglish) 230 methods to implement (97 %) |