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

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

4 голосов
/ 18 ноября 2010

У меня простой вопрос: как мне документировать файл .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?

Ответы [ 3 ]

4 голосов
/ 22 ноября 2010

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

; /// @file simple.ini
; /// This file will do blah blah blah
...
2 голосов
/ 17 января 2017

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

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

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

0 голосов
/ 21 апреля 2015

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

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

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

...