1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.12"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>Doxygen: Lists</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17 $(document).ready(initResizable);
19 <link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
24 <table cellspacing="0" cellpadding="0">
26 <tr style="height: 56px;">
27 <td id="projectalign" style="padding-left: 0.5em;">
28 <div id="projectname">Doxygen
35 <!-- end header part -->
36 <!-- Generated by Doxygen 1.8.12 -->
38 <div id="side-nav" class="ui-resizable side-nav-resizable">
40 <div id="nav-tree-contents">
41 <div id="nav-sync" class="sync"></div>
44 <div id="splitbar" style="-moz-user-select:none;"
45 class="ui-resizable-handle">
48 <script type="text/javascript">
49 $(document).ready(function(){initNavTree('lists.html','');});
51 <div id="doc-content">
53 <div class="headertitle">
54 <div class="title">Lists </div> </div>
56 <div class="contents">
57 <div class="textblock"><p>Doxygen provides a number of ways to create lists of items.</p>
58 <p><b>Using dashes</b></p>
59 <p>By putting a number of column-aligned minus (-) signs at the start of a line, a bullet list will automatically be generated. Instead of the minus sign also plus (+) or asterisk (*) can be used.</p>
60 <p>Numbered lists can also be generated by using a minus followed by a hash or by using a number followed by a dot.</p>
61 <p>Nesting of lists is allowed and is based on indentation of the items.</p>
62 <p>Here is an example:</p>
63 <pre class="fragment"> /*!
67 * -# mouse click event\n
68 * More info about the click event.
69 * -# mouse double click event
76 </pre><p> The result will be:</p>
77 <p>A list of events:</p><ul>
78 <li>mouse events<ol type="1">
79 <li>mouse move event</li>
80 <li>mouse click event<br />
81 More info about the click event.</li>
82 <li>mouse double click event</li>
85 <li>keyboard events<ol type="1">
86 <li>key down event</li>
91 <p>More text here.</p>
92 <p>If you use tabs for indentation within lists, please make sure that <a class="el" href="config.html#cfg_tab_size">TAB_SIZE</a> in the configuration file is set to the correct tab size.</p>
93 <p>You can end a list by starting a new paragraph or by putting a dot (.) on an empty line at the same indentation level as the list you would like to end.</p>
94 <p>Here is an example that speaks for itself:</p>
95 <pre class="fragment">/**
96 * Text before the list
102 * The dot above ends the sub sub item list.
104 * More text for the first sub item
106 * The dot above ends the first sub item.
108 * More text for the first list item
113 * More text in the same paragraph.
115 * More text in a new paragraph.
117 </pre><p><b>Using HTML commands</b></p>
118 <p>If you like you can also use HTML commands inside the documentation blocks.</p>
119 <p>Here is the above example with HTML commands: </p><pre class="fragment"> /*!
122 * <li> mouse events
124 * <li>mouse move event
125 * <li>mouse click event<br>
126 * More info about the click event.
127 * <li>mouse double click event
129 * <li> keyboard events
131 * <li>key down event
132 * <li>key up event
137 </pre><dl class="section note"><dt>Note</dt><dd>In this case the indentation is not important.</dd></dl>
138 <p><b>Using \arg or \li</b></p>
139 <p>For compatibility with the Qt Software's internal documentation tool qdoc and with KDoc, doxygen has two commands that can be used to create simple unnested lists.</p>
140 <p>See <a class="el" href="commands.html#cmdarg">\arg</a> and <a class="el" href="commands.html#cmdli">\li</a> for more info.</p>
142 Go to the <a href="grouping.html">next</a> section or return to the
143 <a href="index.html">index</a>.
145 </div></div><!-- contents -->
146 </div><!-- doc-content -->
147 <!-- start footer part -->
148 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
150 <li class="footer">Generated by
151 <a href="http://www.doxygen.org/index.html">
152 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>