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

Add tips & tricks documentation #219

Merged
merged 3 commits into from
Nov 19, 2023
Merged

Add tips & tricks documentation #219

merged 3 commits into from
Nov 19, 2023

Conversation

jnikula
Copy link
Owner

@jnikula jnikula commented Nov 18, 2023

Add some tips for using Sphinx and Hawkmoth for C/C++ API documentation, etc.

Add some tips and tricks. Start off with a tip on how to document
parameter direction similar to Doxygen @param[in,out].
Copy link
Collaborator

@BrunoMSantos BrunoMSantos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool idea and nice set of tips. Apart from the one I objected to, but I'm ok with it really. I'll leave it up to you ;)

doc/tips.rst Outdated Show resolved Hide resolved
@jnikula jnikula merged commit 98d0f61 into master Nov 19, 2023
5 checks passed
@jnikula
Copy link
Owner Author

jnikula commented Nov 19, 2023

And merged. Thanks for your input @BrunoMSantos !

@jnikula jnikula deleted the doc-tips branch November 19, 2023 09:44
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

Successfully merging this pull request may close these issues.

2 participants