Chapter III: List of Lists
Doxygen has many ways to create item lists
Using dashes use short horizontal bars
At the beginning of each line, "-" head, the following indented alignment, the list is also "-" head, below is an example
/ *!
* A List of events:
* - Mouse Events
* - # Mouse Move Event
* - # mouse Click Event / N
* More Info About The Click Event.
* - # mouse Double Click Event
* - KEYBOARD EVENTS
* - # key down evenet
* - # key up Event
*
* More text here.
* /
This will generate an event list
· Mouse Events
Mouse Move Event
2. Mouse Click Eventmore Info About The Click Event.
3. Mouse Double Cleick Event
KEYBOARD Events
KEY DOWN EVENT
2. Key Up Event
More text here.
If you have been using tabs, then check the Tab_SIZE settings in the configuration configuration file is correct.
Use "." To end a list, start a new paragram, must be "-" alignment you need.
Here is an example:
/ **
* Text Before the List
* - List item 1
* - SUB ITEM 1
* - SUB ITEM 1
* - SUB ITEM 2
*.
* The Dot Above Ends The Sub Item List.
* More text for the first sub item
*.
* The Dot Above Ends The First Sub Item.
* More Text for the first list item
* - SUB ITEM 2
* - SUB ITEM 3
* - List item 2
*.
* More text in The Same Paragraph.
*
* More text in a new paragraph.
* /
Using HTML Commands Using HTML Commands
If you like to consider using the HTML command in the document block. This may be more natural. There is an example below
Note: There is no need to align here.
Using / arg or @li
For Compatibility With the Tool Tech's Internal Documentation Tool and With Kdoc, Doxygen Has Two Commands That Can Be Used To Create Simple Unnested Lists.
See / arg and / li for more info.
