mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve formatting, adjust indenting for proper doxygen output.

Browse Source 
Doxygen has changed in version 1.8.x, such that some (or all?) formatting
commands in lines with more than 3 spaces at the beginning of the line
are ignored (displayed verbatim). 


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10315 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2014-09-16 11:18:16 +00:00
parent 1c7409e0a1
commit 2cba87376f
1 changed files with 55 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
documentation/src/development.dox
View File

@ -104,7 +104,7 @@ Gizmo.cxx:
int popup_gizmo(...); int popup_gizmo(...);
\endverbatim \endverbatim
<H3>Comments Within Doxygen Comment Blocks:</H3> <H3>Comments Within Doxygen Comment Blocks</H3>
You can use HTML comment statements to embed comments in doxygen comment blocks. You can use HTML comment statements to embed comments in doxygen comment blocks.
These comments will not be visible in the generated document. These comments will not be visible in the generated document.
@ -122,19 +122,25 @@ will be shown as:
This will be visible again. This will be visible again.
<H3>Different Headlines:</H3> <H3>Different Headlines</H3>
You can use HTML tags \<H1> ... \<H4> for headlines with different sizes.
As of doxygen 1.8.x there must not be more than three spaces at the
beginning of the line for this to work. Currently (doxygen 1.8.6)
there seems to be no difference in the font sizes of \<H3> and \<H4>
in the pdf output, whereas the html output uses different font sizes.
\code \code
<H1>Headline in big text (H1)</H1> <H1>Headline in big text (H1)</H1>
<H2>Headline in big text (H2)</H2> <H2>Headline in big text (H2)</H2>
<H3>Headline in big text (H3)</H3> <H3>Headline in big text (H3)</H3>
<H4>Headline in big text (H4)</H4> <H4>Headline in big text (H4)</H4>
\endcode \endcode
<H1>Headline in big text (H1)</H1> <H1>Headline in big text (H1)</H1>
<H2>Headline in big text (H2)</H2> <H2>Headline in big text (H2)</H2>
<H3>Headline in big text (H3)</H3> <H3>Headline in big text (H3)</H3>
<H4>Headline in big text (H4)</H4> <H4>Headline in big text (H4)</H4>
\section development_non-ascii Non-ASCII Characters \section development_non-ascii Non-ASCII Characters
@ -149,8 +155,8 @@ This will appear in the document:
Doxygen understands many HTML quoting characters like Doxygen understands many HTML quoting characters like
&quot;, &uuml;, &ccedil;, &Ccedil;, but not all HTML quoting characters. &quot;, &uuml;, &ccedil;, &Ccedil;, but not all HTML quoting characters.
For further informations about HTML quoting characters see For further informations about HTML quoting characters see
\b http://www.doxygen.org/htmlcmds.html <br> \b http://www.doxygen.org/htmlcmds.html
Alternatively you can use \b UTF-8 encoding within Doxygen comments. Alternatively you can use \b UTF-8 encoding within Doxygen comments.
@ -190,7 +196,7 @@ at its top.
This section is This section is
\code \code
\section development_structure Document structure \section development_structure Document Structure
\endcode \endcode
The following section is The following section is
@ -212,7 +218,7 @@ Links to other documents and external links can be embedded with
\code \code
- see chapter \ref unicode creates a link to the named chapter - see chapter \ref unicode creates a link to the named chapter
unicode that has been created with a \page statement. unicode that has been created with a \\page statement.
- For further informations about quoting see - For further informations about quoting see
http://www.doxygen.org/htmlcmds.html http://www.doxygen.org/htmlcmds.html
@ -245,54 +251,54 @@ to provide a paragraph title and also to indent a paragraph. Unfortunately
\b \\par won't do what you expect if you want to have doxygen links and \b \\par won't do what you expect if you want to have doxygen links and
sometimes html tags don't work either. sometimes html tags don't work either.
<!-- use verbatim rather than code to avoid links to code reference --> <!-- use verbatim rather than code to avoid links to code reference -->
\verbatim \verbatim
\par Normal Paragraph with title \par Normal Paragraph with title
This paragraph will have a title, but because there is a blank line This paragraph will have a title, but because there is a blank line
between the \par and the text, it will have the normal layout. between the \par and the text, it will have the normal layout.
\par Indented Paragraph with title \par Indented Paragraph with title
This paragraph will also have a title, but because there is no blank This paragraph will also have a title, but because there is no blank
line between the \par and the text, it will be indented. line between the \par and the text, it will be indented.
\par \par
It is also possible to have an indented paragraph without title. It is also possible to have an indented paragraph without title.
This is how you indent subsequent paragraphs. This is how you indent subsequent paragraphs.
\par No link to Fl_Widget::draw() \par No link to Fl_Widget::draw()
Note that the paragraph title is treated as plain text. Note that the paragraph title is treated as plain text.
Doxygen type links will not work. Doxygen type links will not work.
HTML characters and tags may or may not work. HTML characters and tags may or may not work.
Fl_Widget::draw() links and &quot;html&quot; tags work<br> Fl_Widget::draw() links and &quot;html&quot; tags work<br>
\par \par
Use a single line ending with <br> for complicated paragraph titles. Use a single line ending with <br> for complicated paragraph titles.
\endverbatim \endverbatim
The above code produces the following paragraphs: The above code produces the following paragraphs:
\par Normal Paragraph with title \par Normal Paragraph with title
This paragraph will have a title, but because there is a blank line This paragraph will have a title, but because there is a blank line
between the \\par and the text, it will have the normal layout. between the \\par and the text, it will have the normal layout.
\par Indented Paragraph with title \par Indented Paragraph with title
This paragraph will also have a title, but because there is no blank This paragraph will also have a title, but because there is no blank
line between the \\par and the text, it will be indented. line between the \\par and the text, it will be indented.
\par \par
It is also possible to have an indented paragraph without title. It is also possible to have an indented paragraph without title.
This is how you indent subsequent paragraphs. This is how you indent subsequent paragraphs.
\par No link to Fl_Widget::draw() \par No link to Fl_Widget::draw()
Note that the paragraph title is treated as plain text. Note that the paragraph title is treated as plain text.
Doxygen type links will not work. Doxygen type links will not work.
HTML characters and tags may or may not work. HTML characters and tags may or may not work.
Fl_Widget::draw() links and &quot;html&quot; tags work<br> Fl_Widget::draw() links and &quot;html&quot; tags work<br>
\par \par
Use a single line ending with \<br\> for complicated paragraph titles. Use a single line ending with \<br\> for complicated paragraph titles.
\section development_navigation_test Navigation Elements \section development_navigation_test Navigation Elements