Задайте параметры Doxygen через командную строку
Ну, я создаю script, чтобы автоматически генерировать документацию для моих проектов с Doxygen, которая кажется потрясающим инструментом.
Мне непонятно, может ли пользователь использовать прямые параметры, такие как название проекта, описание проекта и т.д., Установив их помимо команды:
doxygen -g "parameter modification here"
doxygen Doxyfile
Любые советы оценены!
Ответы
Ответ 1
Посмотрите ответ на вопрос 17 в FAQ: http://www.doxygen.org/faq.html, повторенный ниже для удобства:
Могу ли я настроить doxygen из командной строки?
Не через параметры командной строки, но doxygen может читать из stdin, поэтому вы можете передавать через него вещи. Вот пример того, как переопределить опцию в файле конфигурации из командной строки (при условии среды UNIX):
( cat Doxyfile ; echo "PROJECT_NUMBER=1.0" ) | doxygen -
Для Windows следующее будет делать то же самое:
( type Doxyfile & echo PROJECT_NUMBER=1.0 ) | doxygen.exe -
Если указано несколько параметров с тем же именем, то doxygen будет использовать последний. Чтобы добавить к существующей опции, вы можете использовать оператор + =.
Ответ 2
Насколько я знаю, это невозможно: сборка doxygen сконфигурирована с помощью файла конфигурации или с помощью графического интерфейса (что намного проще, чем попытка запомнить команду имена опций линии). Набрав doxygen --help
в командной строке и документацию для использования doxygen, предположим, что все параметры командной строки задают, какой файл конфигурации следует читать (и разрешить пользователю получить файлы макета и т.п.).
Один из способов изменить параметры конфигурации из командной строки - это добавить параметры в файл конфигурации, используя что-то вроде (untested):
echo "INPUT = some file" >> Doxyfile
Это добавит INPUT = some file
к вашему Doxyfile
, и любые предыдущие значения INPUT
будут проигнорированы. Если вы хотите добавить элемент в INPUT
, вы можете использовать
echo "INPUT += some file" >> Doxyfile
Обратите внимание на +=
. Это относится к значениям INPUT
, установленным ранее в файле.
Вместо добавления к файлу конфигурации вы всегда можете использовать sed
для поиска и замены параметров.