Doxygen - Ini as a Text?

Question

I am starting to dokumenting with doxygen and as far as it goes it seems quite easy and helpful !
There is just one file which gives me a headache, my config.ini . This file has different comments, standards etc. . I would like to load it as "code", so the page is not interpreted.

How can I achieve this ?

The following didn't work :
; /// @file config.ini
; /// @code
setting1
setting2
setting3
; /// @endcode

Answer 1

Your question is a little unclear but I assume from your question that you do want to see the contents of the .ini file in the documentation.

For what I think you need I'd suggest using @verbatim rather than @code.

If you are not seeing anything at all, then check that .ini is in the list of filename extensions that doxygen will parse? It's a setting in the doxyfile.

Answer 2

You can do what you want as follows:

Define a page that includes the .ini file, for instance test.dox as follows:

/** @page test_ini test.ini
 *  This is the configuration file:
 *  @verbinclude test.ini
 */

Then set EXAMPLE_PATH in doxygen's config file to the directory that contains test.ini and don't include .ini files in FILE_PATTERNS (so use the default).