search

vovkos / doxyrest

A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
MIT License
306 stars 23 forks source link

Exclude undocumented functions #11

Closed wandns closed 5 years ago

wandns commented 5 years ago

Some functions were showing up in documentation even though they were not documented:

vovkos commented 5 years ago

Unconditionally hiding all undocumented functions is not good. Newly added API members are often undocumented initially -- but we still may need to see them in the overview of API.

But I agree, sometimes hiding undocumented items is required. What we need to do is add some settings similar to HIDE_UNDOC_MEMBERS and HIDE_UNDOC_CLASSES in Doxygen (unfortunately, these are ignored by Doxygen during XML generation).

Let's name the new settings as: g_hideUndocMembers and g_hideUndocCompounds (according to the Doxygen XML data scheme everything is either a member or a compound). Creating separate settings for functions, variables, typedefs, etc. seems excessive -- two settings for members/compounds should be enough. Then we need to check these two settings and conditionally hide undocumented items in all overview frame files (c_overview_*.rst.in).

Also, please use TABS for indentation.

wandns commented 5 years ago

Thanks for the feedback. I will make those adjustments.

wandns commented 5 years ago

I will close this pr and open a new one once the requested changes have been implemented.