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

embed doxygen link in CONTRIBUTING.md #637

Merged
merged 1 commit into from
Sep 24, 2020
Merged

embed doxygen link in CONTRIBUTING.md #637

merged 1 commit into from
Sep 24, 2020

Conversation

2bndy5
Copy link
Member

@2bndy5 2bndy5 commented Sep 22, 2020

starting to get doxygen now. But the official reference manual seems a little vague. e.g. I can't find where the "@" (like @param) commands are explained/listed.

added link to "documenting the code section" to steer prospective contributors in the official direction.

@2bndy5
Copy link
Member Author

2bndy5 commented Sep 22, 2020

nevermind. I think I found it:

All commands in the documentation start with a backslash () or an at-sign (@). If you prefer you can replace all commands starting with a backslash below by their counterparts that start with an at-sign.

I knew I'd find it eventually.

@Avamander Avamander merged commit 6e5195a into master Sep 24, 2020
@Avamander Avamander deleted the add-doxygen-link branch September 24, 2020 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants