2013-12-25 3 views
3

Я пишу инструмент с параметрами командной строки, координируемыми опциями форматирования. API хорошо документирован с Doxygen, но я хотел бы, чтобы Doxygen также документировал параметры командной строки для инструментов, извлекающих информацию из переменных boost_options boost. Это сделало бы HTML полезным и для пользователей, а не для разработчиков.Экспорт аргументов из настроек форматирования в doxygen

Кто-нибудь знает, существует ли такая интеграция между boost program_options и doxygen? Если нет, есть ли какой-нибудь другой инструмент, который дает использование командной строки HTML на основе boost program_options?

+0

Я бы очень просто написал это сам. Для Doxygen IIRC есть плагин для разметки. Вы можете повторно использовать уценку где-нибудь в своей документации. – sehe

+0

Ключ здесь в том, что Doxygen будет читать из моих переменных option_description вместо моей документации, поэтому он всегда будет актуальным. Реализация этого, безусловно, большой проект. – Carneiro

+0

Как бы это было когда-нибудь большой проект? Это не похоже на то, что конфигурация program_options настолько обширна? – sehe

ответ

0

Вот простой способ, который я включил повышение :: program_options документацию моего приложения в моей Doxygen документации:

  1. Выполнить свой исполняемый файл с опцией --help, и отправить вывод в текстовый файл.
  2. Затем в документации по doxygen в одном из исходных файлов используйте команду \ verbinclude, чтобы вставить текстовый файл, который вы создали.

У него нет форматирования HTML, но он выполняет эту работу.

Я лично поставил эти шаги под целью «документов» в своем Makefile, вместо написания сценария.

+0

определенно полезное предложение. Но я искал что-то более полное, которое фактически использовало бы знания из boost :: program_options. – Carneiro

Смежные вопросы