Doxygen-как документировать файлы с нестандартным расширением (.INI)

У меня простой вопрос: как документировать файл .INI?

У меня есть проект C++ со следующим макетом:

readme.txt
src
    main.cpp
data
    simple.ini

У меня нет проблем с созданием документа из readme.txt и main.cpp, но документ в simple.ini вообще не отображается в выводе html. Я исправил файл Doxygen, включив в него следующее:

INPUT = . src data
FILE_PATTERNS = *.cpp *.txt *.ini

Это не помогло. Я также явно указываю simple.ini:

INPUT = readme.txt data/simple.ini src

Но и это не сработало. В simple.ini я использую ';' для комментария:

; @file simple.ini
; This file will do blah blah blah
[section1]
key1 = foo
key2 = bar
...

Я также пытался использовать '#' для комментария, но это тоже не сработало. Как заставить doxygen обрабатывать simple.ini?


doxygen
person Hai Vu    schedule 18.11.2010    source источник

Ответы (3)


arrow_upward
4
arrow_downward

Doxygen ожидает /** или /// для запуска блока комментариев с поддержкой doxygen. Я не знаю, работает ли это, но я бы попытался прокомментировать:

; /// @file simple.ini
; /// This file will do blah blah blah
...
person mouviciel    schedule 22.11.2010
comment
Спасибо, mouviciel, все работает. Однако вывод текста между блоками @code и @endcode беспорядочный: он включает ; потому что Doxygen не узнал ; как символ комментария. На данный момент я использую файл .TXT с тем же именем для документирования моего файла .INI. - person Hai Vu; 23.11.2010

arrow_upward
3
arrow_downward

Чтобы добавить пользовательские расширения файлов в doxygen, вы должны отредактировать две вещи в файле конфигурации:

  • FILE_PATTERNS для частого включения расширения *.extension \
  • EXTENSION_MAPPING должно быть .extension=parser, где синтаксический анализатор — это C, C#, C++, Python и т. д.

В вашем случае установите «.extension» как «.ini» и «parser» как C. Doxygen ожидает две строки следующих /// или //!. Он также принимает многострочные символы /** и /*!.
ИЛИ
установите для параметра "парсер" значение "Python", чтобы использовать комментарии в стиле ##, поскольку # принимается .ini в качестве комментария, хотя это и не рекомендуется. Это должно устранить вашу потребность в ;s

person LikeTheRock    schedule 17.01.2017

arrow_upward
-1
arrow_downward

Я бы сказал, что Doxygen не хватает функции документирования

  • строить скрипты
  • файлы конфигурации
  • пользовательские сценарии для использования в вашей собственной виртуальной машине

Таким образом, окончательное решение — разветвить Doxygen и добавить возможность обработки произвольного языка, такого как Notepad++ или Kate. По пути вы также должны очистить его беспорядочный вывод HTML в стиле 2002 года, чтобы он больше не создавал суп из div.

person user877329    schedule 21.04.2015