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

parse opengl xhtml man pages for generating brief function descriptions/comments #22

Open
cgcostume opened this issue Jul 9, 2014 · 2 comments

Comments

@cgcostume
Copy link
Member

the functions declarations within glbinding might benefit from the brief description, parameters, and return section of the opengl man pages. however, this needs to be applied in a way that, e.g., glVertex### variations all use the same slightly adapted glVertex description.

some minor drawbacks to discuss here:

  • the parsing even though the pages are xhtml, might not be that easy,
  • parsing might take much longer and man pages should be loaded at generation time or stored within the glbinding repository as well?,
  • the deployment package, mainly the functions header massively increase in file size (which should not matter that much, since only comments that are discarded efficiently by compiler?).
@scheibel
Copy link
Member

scheibel commented Jul 9, 2014

Comments should be discarded during the lexer, so the actual compiler shouldn't be bothered.
But this can differ for every compiler, I don't know for sure.

Actually I would prefer a link to the man page as comment for every parsed entry in glbinding instead of the complete documentation in the header files.

@WorldSEnder
Copy link

You could introduce an option in the generation script to switch between the two options? And while you're at it, generate different comments for popular documentation tools - not only doxygen.

@scheibel scheibel transferred this issue from cginternals/glbinding Jan 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants