Listes
Doxygen propose plusieurs façons de créer des listes d'éléments.
Utilisation de tirets
En plaçant un certain nombre de signes moins (-) alignés sur les colonnes au début d'une ligne, une liste à puces sera automatiquement générée. Au lieu du signe moins, vous pouvez également utiliser un signe plus (+) ou un astérisque (*).
Les listes numérotées peuvent également être générées en utilisant un signe moins suivi d'un dièse (#) ou en utilisant un nombre suivi d'un point.
Les listes avec comme indicateur une case à cocher cochée ou non sont possibles lorsqu'elles ont un signe moins suivi d'espaces facultatifs et suivi de [ ] pour une case à cocher non cochée et de [x] ou [X] pour une case à cocher cochée.
L'imbrication des listes est autorisée et est basée sur l'indentation des éléments.
Voici un exemple :
/*!
* 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
* 1. key down event
* 2. key up event
* - checkbox list
* - [ ] unchecked
* - [x] checked
*
* More text here.
*/
Le résultat sera :
Si vous utilisez des tabulations pour l'indentation dans les listes, assurez-vous que TAB_SIZE dans le fichier de configuration est défini sur la taille de tabulation correcte.
Vous pouvez terminer une liste en commençant un nouveau paragraphe ou en plaçant un point (.) sur une ligne vide au même niveau d'indentation que la liste que vous souhaitez terminer.
Voici un exemple qui parle de lui-même :
/**
* Texte avant la liste
* - élément de liste 1
* - sous-élément 1
* - sous-élément sous-élément 1
* - sous-élément sous-élément 2
* .
* Le point au-dessus termine la liste des sous-éléments sous-élément.
*
* Plus de texte pour le premier sous-élément
* .
* Le point au-dessus termine le premier sous-élément.
*
* Plus de texte pour le premier élément de liste
* - sous-élément 2
* - sous-élément 3
* - élément de liste 2
* .
* Plus de texte dans le même paragraphe.
*
* Plus de texte dans un nouveau paragraphe.
*/
Utilisation des commandes HTML
Si vous le souhaitez, vous pouvez également utiliser des commandes HTML à l'intérieur des blocs de documentation.
Voici l'exemple ci-dessus avec des commandes HTML :
/*!
* Une liste d'événements :
* <ul>
* <li> événements de souris
* <ol>
* <li> événement de déplacement de souris
* <li> événement de clic de souris<br>
* Plus d'informations sur l'événement de clic.
* <li> événement de double clic de souris
* </ol>
* <li> événements de clavier
* <ol>
* <li> événement de touche enfoncée
* <li> événement de touche relevée
* </ol>
* </ul>
* Plus de texte ici.
*/
Remarque
Dans ce cas, l'indentation n'est pas importante.
Utilisation de \arg ou \li
Pour la compatibilité avec l'outil de documentation interne de Qt Software qdoc et avec KDoc, Doxygen dispose de deux commandes qui peuvent être utilisées pour créer des listes simples non imbriquées.