|
1 /*! \page lists Lists |
|
2 |
|
3 Doxygen provides a number of ways to create lists of items. |
|
4 |
|
5 <b>Using dashes</b> |
|
6 |
|
7 By putting a number of column-aligned minus signs at the start of a |
|
8 line, a bullet list will automatically be generated. |
|
9 Numbered lists can also be generated by using a minus followed by a hash. |
|
10 Nesting of lists is allowed and is based on indentation of the items.<p> |
|
11 Here is an example: |
|
12 \verbatim |
|
13 /*! |
|
14 * A list of events: |
|
15 * - mouse events |
|
16 * -# mouse move event |
|
17 * -# mouse click event\n |
|
18 * More info about the click event. |
|
19 * -# mouse double click event |
|
20 * - keyboard events |
|
21 * -# key down event |
|
22 * -# key up event |
|
23 * |
|
24 * More text here. |
|
25 */ |
|
26 \endverbatim |
|
27 The result will be: |
|
28 |
|
29 A list of events: |
|
30 - mouse events |
|
31 -# mouse move event |
|
32 -# mouse click event\n |
|
33 More info about the click event. |
|
34 -# mouse double click event |
|
35 - keyboard events |
|
36 -# key down event |
|
37 -# key up event |
|
38 |
|
39 More text here. |
|
40 |
|
41 If you use tabs for indentation within lists, please make sure |
|
42 that \ref cfg_tab_size "TAB_SIZE" in the configuration file is set to |
|
43 the correct tab size. |
|
44 |
|
45 You can end a list by starting a new paragraph or |
|
46 by putting a dot (.) on an empty line at the same indent level as the |
|
47 list you would like to end. |
|
48 |
|
49 Here is an example that speaks for itself: |
|
50 |
|
51 \verbatim |
|
52 /** |
|
53 * Text before the list |
|
54 * - list item 1 |
|
55 * - sub item 1 |
|
56 * - sub sub item 1 |
|
57 * - sub sub item 2 |
|
58 * . |
|
59 * The dot above ends the sub sub item list. |
|
60 * More text for the first sub item |
|
61 * . |
|
62 * The dot above ends the first sub item. |
|
63 * More text for the first list item |
|
64 * - sub item 2 |
|
65 * - sub item 3 |
|
66 * - list item 2 |
|
67 * . |
|
68 * More text in the same paragraph. |
|
69 * |
|
70 * More text in a new paragraph. |
|
71 */ |
|
72 \endverbatim |
|
73 |
|
74 <b>Using HTML commands</b> |
|
75 |
|
76 If you like you can also use HTML commands inside the documentation |
|
77 blocks. Using these commands has the advantage that it is more natural |
|
78 for list items that consist of multiple paragraphs. |
|
79 |
|
80 Here is the above example with HTML commands: |
|
81 \verbatim |
|
82 /*! |
|
83 * A list of events: |
|
84 * <ul> |
|
85 * <li> mouse events |
|
86 * <ol> |
|
87 * <li>mouse move event |
|
88 * <li>mouse click event\n |
|
89 * More info about the click event. |
|
90 * <li>mouse double click event |
|
91 * </ol> |
|
92 * <li> keyboard events |
|
93 * <ol> |
|
94 * <li>key down event |
|
95 * <li>key up event |
|
96 * </ol> |
|
97 * </ul> |
|
98 * More text here. |
|
99 */ |
|
100 \endverbatim |
|
101 |
|
102 \note In this case the indentation is not important. |
|
103 |
|
104 <b>Using \\arg or \@li</b> |
|
105 |
|
106 For compatibility with the Qt Software's internal documentation tool qdoc and |
|
107 with KDoc, doxygen has two commands that can be used to create simple |
|
108 unnested lists. |
|
109 |
|
110 See \ref cmdarg "\\arg" and \ref cmdli "\\li" for more info. |
|
111 |
|
112 \htmlonly |
|
113 Go to the <a href="grouping.html">next</a> section or return to the |
|
114 <a href="index.html">index</a>. |
|
115 \endhtmlonly |
|
116 |
|
117 */ |
|
118 |
|
119 |