From 2cba87376f02b398f591cf76732716bee3b73564 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Tue, 16 Sep 2014 11:18:16 +0000 Subject: Improve formatting, adjust indenting for proper doxygen output. 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 --- documentation/src/development.dox | 104 ++++++++++++++++++++------------------ 1 file changed, 55 insertions(+), 49 deletions(-) (limited to 'documentation/src') diff --git a/documentation/src/development.dox b/documentation/src/development.dox index a25e66c4c..b53c3a87e 100644 --- a/documentation/src/development.dox +++ b/documentation/src/development.dox @@ -104,7 +104,7 @@ Gizmo.cxx: int popup_gizmo(...); \endverbatim -

Comments Within Doxygen Comment Blocks:

+

Comments Within 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. @@ -122,19 +122,25 @@ will be shown as: This will be visible again. -

Different Headlines:

+

Different Headlines

+ +You can use HTML tags \

... \

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 \

and \

+in the pdf output, whereas the html output uses different font sizes. \code -

Headline in big text (H1)

-

Headline in big text (H2)

-

Headline in big text (H3)

-

Headline in big text (H4)

+

Headline in big text (H1)

+

Headline in big text (H2)

+

Headline in big text (H3)

+

Headline in big text (H4)

\endcode -

Headline in big text (H1)

-

Headline in big text (H2)

-

Headline in big text (H3)

-

Headline in big text (H4)

+

Headline in big text (H1)

+

Headline in big text (H2)

+

Headline in big text (H3)

+

Headline in big text (H4)

\section development_non-ascii Non-ASCII Characters @@ -149,8 +155,8 @@ This will appear in the document: Doxygen understands many HTML quoting characters like ", ü, ç, Ç, but not all HTML quoting characters. -For further informations about HTML quoting characters see - \b http://www.doxygen.org/htmlcmds.html +For further informations about HTML quoting characters see +
\b http://www.doxygen.org/htmlcmds.html Alternatively you can use \b UTF-8 encoding within Doxygen comments. @@ -190,7 +196,7 @@ at its top. This section is \code - \section development_structure Document structure + \section development_structure Document Structure \endcode The following section is @@ -212,7 +218,7 @@ Links to other documents and external links can be embedded with \code - 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 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 sometimes html tags don't work either. - - \verbatim - \par Normal Paragraph with title + +\verbatim + \par Normal Paragraph with title - 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. + 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. - \par Indented Paragraph with title - This paragraph will also have a title, but because there is no blank - line between the \par and the text, it will be indented. + \par Indented Paragraph with title + This paragraph will also have a title, but because there is no blank + line between the \par and the text, it will be indented. - \par - It is also possible to have an indented paragraph without title. - This is how you indent subsequent paragraphs. + \par + It is also possible to have an indented paragraph without title. + This is how you indent subsequent paragraphs. - \par No link to Fl_Widget::draw() - Note that the paragraph title is treated as plain text. - Doxygen type links will not work. - HTML characters and tags may or may not work. + \par No link to Fl_Widget::draw() + Note that the paragraph title is treated as plain text. + Doxygen type links will not work. + HTML characters and tags may or may not work. - Fl_Widget::draw() links and "html" tags work
- \par - Use a single line ending with
for complicated paragraph titles. - \endverbatim + Fl_Widget::draw() links and "html" tags work
+ \par + Use a single line ending with
for complicated paragraph titles. +\endverbatim 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 - between the \\par and the text, it will have the normal layout. + 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. - \par Indented Paragraph with title - This paragraph will also have a title, but because there is no blank - line between the \\par and the text, it will be indented. + \par Indented Paragraph with title + This paragraph will also have a title, but because there is no blank + line between the \\par and the text, it will be indented. - \par - It is also possible to have an indented paragraph without title. - This is how you indent subsequent paragraphs. + \par + It is also possible to have an indented paragraph without title. + This is how you indent subsequent paragraphs. - \par No link to Fl_Widget::draw() - Note that the paragraph title is treated as plain text. - Doxygen type links will not work. - HTML characters and tags may or may not work. + \par No link to Fl_Widget::draw() + Note that the paragraph title is treated as plain text. + Doxygen type links will not work. + HTML characters and tags may or may not work. - Fl_Widget::draw() links and "html" tags work
- \par - Use a single line ending with \ for complicated paragraph titles. + Fl_Widget::draw() links and "html" tags work
+ \par + Use a single line ending with \ for complicated paragraph titles. \section development_navigation_test Navigation Elements -- cgit v1.2.3