Doxygen предоставляет несколько способов создания списков элементов.
Использование тире
Размещение знака «минус» в начало строки с учетом отступов, точки в списке будут автоматически сформированы. Нумерованные списки также могут быть сгенерированы с помощью знаков «минус» и «решетка». Вложение списков разрешено и основано на сдвиге элементов.
Вот пример:
/*! * Список элементов: * - mouse events * -# mouse move event * -# mouse click event * Дополнительно о click event. * -# mouse double click event * - keyboard events * -# key down event * -# key up event * * Здесь дополнительный текст. */
Результатом будет:
Список элементов:
- mouse events
- mouse move event
- mouse click event
Дополнительно о click event. - mouse double click event
- keyboard events
- key down event
- key up event
Здесь дополнительный текст.
Если Вы используете табуляцию для сдвига в списках, пожалуйста убедитесь, что в конфигурационном файле установлено корректрое значения размера табуляции TAB_SIZE.
Вы можете закончить список, начав новый параграф или поставив точку (.) на пустой строке том же уровне сдвига как и у списка, который Вы хотите завершить.
Здесь пример говорящий сам за себя:
/** * Текст перед списком * - list item 1 * - sub item 1 * - sub sub item 1 * - sub sub item 2 * . * Точка выше заканчивает sub sub item списка. * Еще тескт для первого sub item * . * Точка выше заканчивает первый sub item. * Еще текст для первого list item * - sub item 2 * - sub item 3 * - list item 2 * . * Еще текст в том же абзаце. * * Текст в новом абзаце. */
Использование команд HTML
Если вам нравиться, Вы можете также использовать команды HTML в блоках документации. Использование этих команд дает преимущество, как более естественное состояние множественных абзвцев для элементов списка.
Вот предыдущий пример с командами HTML:
/*! * Список элементов: * <ul> * <li>mouse events * <ol> * <li>mouse move event * <li>mouse click event * Дополнительно о click event. * <li>mouse double click event * </ol> * <li>keyboard events * <ol> * <li>key down event * <li>key up event * </ol> * </ul> * Здесь еще текст. */
Замечание: В этом случае отступ не важен.
Использование arg или @li
Для совместимости со средством внутреннего документирования Qt Software — qdoc и с KDoc, в doxygen есть 2 команды, которые могут быть использованы для создания простых невложенных списков.