Doxygen - How to document files with a non-standard extension (.INI)

I have a simple question: how can I document a .INI file?

I have a C ++ project with the following location:

readme.txt
src
    main.cpp
data
    simple.ini

I have no problem creating a document from readme.txt and main.cpp, but the document in simple.ini does not appear at all in the html output file. I installed a Doxygen file to include the following:

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

It did not help. I also explicitly specify simple.ini:

INPUT = readme.txt data/simple.ini src

But that didn't work either. In simple.ini, I use ';' for comment:

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

I also tried using '#' for a char comment, but that didn't work either. How to make doxygen handle simple.ini?

+3
source share
3 answers

Doxygen /** /// , . , , :

; /// @file simple.ini
; /// This file will do blah blah blah
...
+3

doxygen, :

  • FILE_PATTERNS *.extension \
  • EXTENSION_MAPPING .extension=parser, C, #, ++, Python ..

".extension" ".ini" "parser" C. Doxygen ///, //!. /** /*!.

'parser' 'Python', ##, # .ini , . ; s

+1

, Doxygen

  • vm

So the final solution is fork Doxygen and adds the ability to handle arbitrary languages ​​like Notepad ++ or Kate. Along the way, you should also clear your messy HTML-style HTML output, so it no longer generates soup soup.

0
source

Source: https://habr.com/ru/post/1775661/


All Articles