[doxygenfunction: Cannot find function] When header file function declaration comment out with DOXYGEN_SHOULD_SKIP_THIS about exhale

[svenevs]

Hi @Visit-Learn,

I am new for this tool, I am not sure that I can ask question here or not.

Sorry for the delay, questions are welcome! Development is slow right now though :S

Edit: also, thanks for a detailed issue report -- was easy to reproduce the problem which helped eventually finding it 🙂

This behavior seems to be a feature of breathe, I wasn't aware of this until now. Apparently the .. doxygenfunction directive by default ignores source files. They will create a filter finder which ultimately rage quits for implementation files.

With your current setup, you would need to set breathe_implementation_filename_extensions to trick it into documenting the .c files the way you want in your conf.py:

# example ... could also add '.h'
breathe_implementation_filename_extensions = []

That will succeed in building the docs. Some notes:

1. By default, using the exhale stdin approach, DOXYGEN_SHOULD_SKIP_THIS is already defined in addition to DOXYGEN_DOCUMENTATION_BUILD. It doesn't hurt to add it on that last line PREDEFINED += DOXYGEN_SHOULD_SKIP_THIS), but in this case it was a red herring ha!

2. You're kind of fighting the conventions here. Typically documentation is added in the .h files, not in the .c files. So, if it's possible and acceptable for your circumstances, the ideal scenario would be to avoid documenting C files at all. INPUT = ../include and FILE_PATTERNS = *.h (though since your code base is separated, it seems you may not need to override FILE_PATTERNS -- just depends on what files you have where). Doing this means that

   • You won't need to mess with breathe_implementation_filename_extensions
   • You don't need all this extra #if !defined(DOXYGEN_DOCUMENTATION_BUILD) everywhere.

Does that make sense?

[svenevs]

Going to close this as resolved, please re-open if the above suggestions didn't work!