C ++ Doxygen + дышать таблицы - PullRequest
Новая
       17

C ++ Doxygen + дышать таблицы

0 голосов
/ 29 июня 2018

У меня большой проект на c ++, документированный с помощью doxygen. Я хочу использовать дыхание, чтобы сделать более приятные руководства. Входящая документация часто содержит такие таблицы: 

/**
 * @var somevar
 * @brief some variable
 * @defgroup somegroup Some Group
 * @details This stores some value in some variable
 * | English | German | Parameters |
 * |---------|--------|------------|
 * | `content of somevar %%s in english.\n` | `content of somevar %%s in German\n` |`<Battery percent>` |
 */

Я генерирую XML-документы в build/xml с помощью doxygen и запускаю sphinx для генерации документов. 

doxygen Doxyfile
make html
make latexpdf

Структура каталогов выглядит следующим образом: 

├── build
├── Doxyfile
├── make.bat
├── Makefile
└── source
    ├── conf.py
    ├── index.rst
    ├── somegroup.rst
    ├── _static
    └── _templates

Все работает нормально, документы созданы, но таблица отсутствует. Я вижу таблицу в build/xml/group___somegroup.xml. Таблица также показана в html-выводе doxygen. Но он отсутствует в html и pdf, генерируемых sphinx + дышать.

Я не могу найти никаких ссылок на то, что таблицы содержания кислорода не поддерживаются дыханием. Чего мне не хватает?

1 Ответ

0 голосов
/ 29 июня 2018

выдох имеет некоторую полезную информацию:

Столы

Совет

С этого момента все может вызвать проблемы с Doxygen. Используйте первую дословную среду, описанную в разделе «Псевдонимы Doxygen».

Использовать таблицы сетки !!!

Это поможет вам их псевдонимы для кислорода :

1020 * Алиасы *

В частности, два псевдонима, которые предоставляет Exhale, взяты из Breathe и позволяют вам использовать полноценный reStructuredText (включая директивы, таблицы сетки и т. Д.) В «дословной» среде. Псевдонимы, отправленные в Doxygen: 

# Allow for rst directives and advanced functions e.g. grid tables
ALIASES  = "rst=\verbatim embed:rst:leading-asterisk"
ALIASES += "endrst=\endverbatim"

Это позволяет вам сделать что-то подобное в вашем коде: 

/**
 * \file
 *
 * \brief This file does not even exist in the real world.
 *
 * \rst
 * There is a :math:`N^2` environment for reStructuredText!
 *
 * +-------------------+-------------------+
 * | Grid Tables       | Are Beautiful     |
 * +===================+===================+
 * | Easy to read      | In code and docs  |
 * +-------------------+-------------------+
 * | Exceptionally flexible and powerful   |
 * +-------+-------+-------+-------+-------+
 * | Col 1 | Col 2 | Col 3 | Col 4 | Col 5 |
 * +-------+-------+-------+-------+-------+
 *
 * \endrst
 */

Не так приятно, но я могу жить с этим.

...