gpp icon indicating copy to clipboard operation
gpp copied to clipboard

Published 20 hours ago • verified publisher icon logological

Doxygen Generation

Open mofosyne opened this issue 7 years ago • 1 comments

I am currently trying to analyse the code to understand how it works.

To make it easier, I'm generating a doxygen document for it. I have attached a pull request, that contains the doxyfile config as well as a script that auto checks if you have doxygen and graphviz installed. If not it will prompt you to install it. Else it shall run it as normal and automatically open the documentation page for it in one go.

I currently have it set to just read out all the functions and render all the call graphs within gpp.c . This is okay for a codebase of this size. At least until we can refactor this correctly.

  • Pull Request: https://github.com/logological/gpp/pull/19

mofosyne avatar Jun 07 '17 14:06 mofosyne

Though I appreciate that automatically generated source documentation may assist GPP developers, I'm not sure that it will add much value to GPP's users. After all, GPP isn't an API. Are you aware of any other software packages, other than libraries, that include Doxygen-generated source documentation?

logological avatar Aug 31 '17 15:08 logological