Closed paulreimer closed 5 years ago
I should note that Doxygen HTML output does include @file
and @directory
list as part of the module (I think any object of any type, within the @ingroup {}
is captured into the module page)
Hi @paulreimer
That sounds like a good idea! I'll get back to this tomorrow, will try to implement it.
@paulreimer
I have a good news and bad news.
The bad news is that the XML generated by Doxygen does not include <innderdir>
inside of the group/module XML file. Only the <innderfile>
is present. Meaning, I can not extract what directories are included within the module, only files. The innerdir are present on the original HTML generaeted by Doxygen, but not the XML. Seems like this is a bug? I have the latest version 1.8.15.
To be more specific, the XML for group/module group__animals.xml
(taken from example whin the repository) contains the following:
<innerfile refid="config_8h">config.h</innerfile>
The <innerdir>
is completely missing, but in the HTML, it is there:
I have no idea why is that...
Files, including a description, are now working. Example below:
Additionally, I have added brief description to the file index, see files.md
file. This does include directories and their brief description. If you really need description for directories, this can be an alternative solution. Example below:
The latest changes are in the master, and released on https://pypi.org/project/doxybook/2.1.6/
Closing for inactivity.
Not sure what is the expected output (maybe I've configured it incorrectly and it should be showing), but I would like to see all the
@file
s and@directory
s in each Module. I think right now, only {classes, functions, variables, ns} are shown.Ideally this would be displayed in a table (similar to classes, etc) with the
file
name in first column and brief in second column.