-
Notifications
You must be signed in to change notification settings - Fork 412
Add ezgl Doxygen api documentation to to the VTR docs #3045
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @SamuelHo10 !
This looks good and I'm merging it, but I have one suggestion:
|
Thanks @SamuelHo10 A couple of suggestions:
|
@soheilshahrouz : good point on libvtrutil. I suggested putting ezgl under vtrutil (thinking of it as a utility) but you are right it is not part of the library we build for utilities so probably it would be better to make it another top level category; we could move it between vtrutil API and vtr internals |
Another suggestion @SamuelHo10, I think you should squash the commits for this PR into a single commit with a descriptive commit message. While it doesn't really matter that much for a documentation change, it's good practice to have atomic commits i.e. commits that take the code from one working state to another and do/add one thing to the code nonetheless. You can look here to see how squashing and some other useful git tools work: Also if you use the GitLens extension for VSCode it gives you a nice UI which might be easier to work with. Just make that when you run Sorry to give you extra work! |
Integrated EZGL’s Doxygen documentation into the VTR ReadTheDocs site under a new "EZGL" tab in the vtrutil API section.
The header files containing only functions and no classes did not generate documentation correctly when I used
.. doxygenfile:: control.hpp
:project: ezgl
I am not sure why, but adding the functions manually in worked:
.. doxygenfunction:: ezgl::zoom_in(canvas*, double)
:project: ezgl