Создание блок-схем теории управления с помощью Doxygen - PullRequest
Новая
       38

Создание блок-схем теории управления с помощью Doxygen

4 голосов
/ 07 октября 2011

Я работаю над проектом C ++ в области автоматики, я хотел бы начать документирование. Я скорее решил для Doxygen. Но, кроме документирования отдельных полей данных и отрисовки UML-диаграмм иерархии классов, я хотел бы документировать функциональность нескольких методов с помощью блок-схем, подобных этой: enter image description here

Какие есть решения?

Я знаком с LaTeX. Я читал, что Doxygen имеет некоторую поддержку LaTeX, но я не знаю, как далеко это заходит. Можно ли использовать какой-либо пакет LaTeX в Doxygen? Какие конкретные пакеты вы бы порекомендовали и могли бы вы привести несколько простых примеров?

Я также открыт для рекомендаций чего-то отличного от Doxygen.

1 Ответ

2 голосов
/ 04 сентября 2012

Если речь идет только о документировании структуры систем управления, переменных и т. Д., Вы можете сгенерировать диаграмму в другом месте (например, Dia, XFig или Inkscape, если вы хотите использовать инструменты с открытым исходным кодом) и встраивать их в документацию Doxygen через изображение. ключевое слово из вашего кода: 

/*!
.. Doxygen doc here..
\image html Data_Model.png "Figure 1: UML Diagram of the Data Source and Data Model Relationships"
*/

Для этого вам нужно указать Doxygen в файле Doxyfile , где искать изображения, и разместить изображения относительно вашего пути doxygen (в данном случае DOCROOT / images): 

# The IMAGE_PATH tag can be used to specify one or more files or 
# directories that contain image that are included in the documentation (see 
# the \image command).

IMAGE_PATH             = images

Использование латексных расширений или других управляемых языком графических разметок для создания графиков из Doxygen doc не оправдывает затраты на изучение языка, настройку и выравнивание цепочки инструментов. С другой стороны, если у вас уже есть какой-то инструмент, который генерирует график автоматически (из вашего кода или файла конфигурации), то вам не составит труда запустить инструмент из Makefile, позволить ему сгенерировать изображение и внедрить изображение в Ваш Doxygen Doc с помощью ключевого слова изображения.

...