документирование текстовых файлов в Doxygen - PullRequest
1 голос
/ 28 октября 2011

Я использую Doxygen для документирования проекта Python.Приложение использует несколько небольших текстовых файлов, содержащих, например, информацию о конфигурации, журналы и т. Д. По очевидным причинам, информация Doxygen не может быть включена в эти файлы напрямую (проблемы с синтаксическим анализом, эти файлы могут не существовать) - мне нужно написать этот документ в другомфайлы (содержащие код).

Проблема в том, что я не могу сделать файлы dox 2 в одном файле кода (или, по крайней мере, std doxyconf не позволяет этого - не генерируется документ для этих второстепенных или несуществующих файлов)

Знаете, как это побороть?Какой конкретный твик в conf нужно сделать?Или мне лучше создать файл .py (тот же каталог, что и у рассматриваемого файла), который будет содержать только комментарии (документацию)?

Заранее спасибо.

Редактировать.Хорошо, постараюсь сделать это понятнее.Скажем, я получил свой код в следующих файлах:

(...)/project/functions.py
(...)/project/interface.py
(...)/project/data/js/functions.js

при запуске приложение генерирует несколько каталогов:

(...)/project/data/gallery/gallery1
(...)/project/data/gallery/gallery2
(...)/project/data/gallery/gallery3

в gallery1, у нас есть 3 jpgs и 3xmls, в gallery2 - 1JPG, галерея3- 5xJPG и 5xXML.Все из которых - загружены пользователем.Поскольку галереи 1, 2 и 3 используются несколько по-другому, после создания этих каталогов мы также создаем файл:

(...)/project/data/gallery/types.info

Этот файл содержит информацию в формате:

gallery1#galleryType1
gallery2#galleryType2
gallery3#galleryType1

Примечание.,Если приложение бездействует (пользователь ничего не делает), нет галерей и нет файла types.info ... Теперь я хочу создать запись doxygen об этом плохом types.info, чтобы он был виден в файлахвкладка.@Verbinclude не работает :( Я добавил тег @package, и это может быть обходной путь, но было бы неплохо, если бы этот файл был задокументирован на вкладке Файлы на странице документа ... Очистить?:)

1 Ответ

0 голосов
/ 28 декабря 2011

Вы можете сделать это с помощью атрибута @file в блоке документации, например:

/**
 * @file project/data/gallery/types.info
 * Documentation for types.info in project/data/gallery/.
 */

Для того, чтобы это работало, вам также необходимо добавить types.infoв качестве действительного имени входного файла doxygen (убедитесь, что атрибуты конфигурации doxygen INPUT и FILE_PATTERNS будут включать его), и файл должен существовать (но он может быть пустым).этот подход заключается в том, что он не работает с комментариями doxygen в стиле Python:

## @file project/data/gallery/types.info
# Documentation for types.info in project/data/gallery/.

Вам понадобится исходный файл, который может содержать комментарии в стиле C / C ++, и этот файл также будет отображатьсяпод вкладкой файлов.

...