\hypertarget{lists}{}\section{Lists}\label{lists}
 Doxygen has a number of ways to create lists of items.

{\bf Using dashes}

By putting a number of column-aligned minus signs at the start of a  line, a bullet list will automatically be generated.  Numbered lists can also be generated by using a minus followed by a hash. Nesting of lists is allowed.

 Here is an example: 

\footnotesize\begin{verbatim}
  /*! 
   *  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 event
   *         -# key up event
   *
   *  More text here.
   */
\end{verbatim}\normalsize 
 The result will be:

A list of events:\begin{CompactItemize}
\item 
mouse events\begin{enumerate}
\item 
mouse move event\item 
mouse click event\par
 More info about the click event.\item 
mouse double click event\end{enumerate}
\item 
keyboard events\begin{enumerate}
\item 
key down event\item 
key up event\end{enumerate}
\end{CompactItemize}
More text here.

If you use tabs within lists, please make sure that \hyperlink{config_cfg_tab_size}{TAB\_\-SIZE} in the  configuration file is set to the correct tab size.

{\bf Using HTML commands}

If you like you can also use HTML commands inside the documentation blocks. Using these commands has the advantage that it is more natural for list items that consists of multiple paragraphs.

Here is the above example with HTML commands: 

\footnotesize\begin{verbatim}
  /*! 
   *  A list of events:
   *  <ul>
   *  <li> mouse events
   *     <ol>
   *     <li>mouse move event
   *     <li>mouse click event\n
   *         More info about the click event.
   *     <li>mouse double click event
   *     </ol>
   *  <li> keyboard events
   *     <ol>     
   *     <li>key down event
   *     <li>key up event
   *     </ol>
   *  </ul>
   *  More text here.
   */
\end{verbatim}\normalsize 


\begin{Desc}
\item[Note: ]\par
The indentation here is not important.\end{Desc}
{\bf Using $\backslash$arg or @li}

For compatibility with the Troll Tech's internal documentation tool and with KDoc, doxygen has two commands that can be used to create simple unnested lists.

See \hyperlink{cmdarg}{$\backslash$arg} and \hyperlink{cmdli}{$\backslash$li} for more info.



