Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
DOXYGEN: updates in header files 1 #2467
Add and improve doxygen blocks in the header file.
Just opening a PR with a single file to get some feedback from you if this is the way to proceed.
Output is available on https://b-gent.github.io/PR2467/group__common.html
I have two more files changed locally on this branch which I will push today so please wait a bit with approving/merging.
Also, as you can see in the output, for example here:
There are not so many in the 3 first files but I am now working with arrays.h and about half of the functions there is not described:
@sev- Do you think we have the capability for developers to provide me with these descriptions? Even if not for all structures, we need someone to identify which are the more important ones that need documentation and which we can skip (at least for now).
It seems to me providing a description for everything will be barely possible. A file like arrays.h misses documentation for about 30 structures. And there are 80 headers in the common folder alone.