tri11paragon
/
OpenGL-Doc-Generator
mirror of https://github.com/Tri11Paragon/OpenGL-Doc-Generator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cleanup

main
Brett 2023-12-24 14:42:49 -05:00
parent 9a9f9b25d1
commit fa383d42e1
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -40,7 +40,7 @@ python path, output location along with level of detail via flags passed to the
``` ```
You can also specify detail flags which will cause certain sections to be removed from the comments. You can also specify detail flags which will cause certain sections to be removed from the comments.
This is useful because this program can easily bloat the file size to be tens of thousands of lines which some This is useful because this program can easily bloat the file size to be tens of thousands of lines which some
IDEs do not handle. IDEs do not like.
``` ```
--no-see, -s # Don't include @see sections --no-see, -s # Don't include @see sections
--no-desc, -d # Don't include the @descrition section --no-desc, -d # Don't include the @descrition section
@ -65,6 +65,7 @@ Generates a commented file where comments are of the style:
* @code void glInvalidateTexSubImage(GLuint texture, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLsizei width, GLsizei height, GLsizei depth); @endcode * @code void glInvalidateTexSubImage(GLuint texture, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLsizei width, GLsizei height, GLsizei depth); @endcode
*/ */
``` ```
in the local directory called `gl.h` from a file of the same name in the parent directory.
```shell ```shell
./gl_doc_generator -b --output ./gl.h ../gl.h ./gl_doc_generator -b --output ./gl.h ../gl.h
``` ```