|
Packit |
1c1d7e |
/*! \page lists Lists
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Doxygen provides a number of ways to create lists of items.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Using dashes
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
By putting a number of column-aligned minus (-) signs at the start of a
|
|
Packit |
1c1d7e |
line, a bullet list will automatically be generated. Instead of the minus
|
|
Packit |
1c1d7e |
sign also plus (+) or asterisk (\*) can be used.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Numbered lists can also be generated by using a minus followed by a hash
|
|
Packit |
1c1d7e |
or by using a number followed by a dot.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Nesting of lists is allowed and is based on indentation of the items.
|
|
Packit |
1c1d7e |
Here is an example:
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\verbatim
|
|
Packit |
1c1d7e |
/*!
|
|
Packit |
1c1d7e |
* A list of events:
|
|
Packit |
1c1d7e |
* - mouse events
|
|
Packit |
1c1d7e |
* -# mouse move event
|
|
Packit |
1c1d7e |
* -# mouse click event\n
|
|
Packit |
1c1d7e |
* More info about the click event.
|
|
Packit |
1c1d7e |
* -# mouse double click event
|
|
Packit |
1c1d7e |
* - keyboard events
|
|
Packit |
1c1d7e |
* 1. key down event
|
|
Packit |
1c1d7e |
* 2. key up event
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* More text here.
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
\endverbatim
|
|
Packit |
1c1d7e |
The result will be:
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
A list of events:
|
|
Packit |
1c1d7e |
- mouse events
|
|
Packit |
1c1d7e |
-# mouse move event
|
|
Packit |
1c1d7e |
-# mouse click event\n
|
|
Packit |
1c1d7e |
More info about the click event.
|
|
Packit |
1c1d7e |
-# mouse double click event
|
|
Packit |
1c1d7e |
- keyboard events
|
|
Packit |
1c1d7e |
1. key down event
|
|
Packit |
1c1d7e |
2. key up event
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
More text here.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
If you use tabs for indentation within lists, please make sure
|
|
Packit |
1c1d7e |
that \ref cfg_tab_size "TAB_SIZE" in the configuration file is set to
|
|
Packit |
1c1d7e |
the correct tab size.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
You can end a list by starting a new paragraph or
|
|
Packit |
1c1d7e |
by putting a dot (.) on an empty line at the same indentation level as the
|
|
Packit |
1c1d7e |
list you would like to end.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Here is an example that speaks for itself:
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\verbatim
|
|
Packit |
1c1d7e |
/**
|
|
Packit |
1c1d7e |
* Text before the list
|
|
Packit |
1c1d7e |
* - list item 1
|
|
Packit |
1c1d7e |
* - sub item 1
|
|
Packit |
1c1d7e |
* - sub sub item 1
|
|
Packit |
1c1d7e |
* - sub sub item 2
|
|
Packit |
1c1d7e |
* .
|
|
Packit |
1c1d7e |
* The dot above ends the sub sub item list.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* More text for the first sub item
|
|
Packit |
1c1d7e |
* .
|
|
Packit |
1c1d7e |
* The dot above ends the first sub item.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* More text for the first list item
|
|
Packit |
1c1d7e |
* - sub item 2
|
|
Packit |
1c1d7e |
* - sub item 3
|
|
Packit |
1c1d7e |
* - list item 2
|
|
Packit |
1c1d7e |
* .
|
|
Packit |
1c1d7e |
* More text in the same paragraph.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* More text in a new paragraph.
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
\endverbatim
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Using HTML commands
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
If you like you can also use HTML commands inside the documentation
|
|
Packit |
1c1d7e |
blocks.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Here is the above example with HTML commands:
|
|
Packit |
1c1d7e |
\verbatim
|
|
Packit |
1c1d7e |
/*!
|
|
Packit |
1c1d7e |
* A list of events:
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* mouse events
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* mouse move event
|
|
Packit |
1c1d7e |
* mouse click event
|
|
Packit |
1c1d7e |
* More info about the click event.
|
|
Packit |
1c1d7e |
* mouse double click event
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* keyboard events
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* key down event
|
|
Packit |
1c1d7e |
* key up event
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* More text here.
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
\endverbatim
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\note In this case the indentation is not important.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Using \\arg or \\li
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
For compatibility with the Qt Software's internal documentation tool qdoc and
|
|
Packit |
1c1d7e |
with KDoc, doxygen has two commands that can be used to create simple
|
|
Packit |
1c1d7e |
unnested lists.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
See \ref cmdarg "\\arg" and \ref cmdli "\\li" for more info.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\htmlonly
|
|
Packit |
1c1d7e |
Go to the next section or return to the
|
|
Packit |
1c1d7e |
index.
|
|
Packit |
1c1d7e |
\endhtmlonly
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
|