Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen Generation #21

Open
mofosyne opened this issue Jun 7, 2017 · 1 comment
Open

Doxygen Generation #21

mofosyne opened this issue Jun 7, 2017 · 1 comment

Comments

@mofosyne
Copy link

mofosyne commented Jun 7, 2017

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.

@logological
Copy link
Owner

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants