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

Create skeleton for doxygen comments #41

Merged
merged 5 commits into from
Nov 22, 2023
Merged

Create skeleton for doxygen comments #41

merged 5 commits into from
Nov 22, 2023

Conversation

akorgor
Copy link
Collaborator

@akorgor akorgor commented Nov 14, 2023

This commit creates a skeleton for Doxygen comments. It highlights locations where doxygen comments should appear with simple placeholder comments, most of which need to be improved. This PR is meant as a discussion base for agreeing on an appropriate content level and layout of these comments and is thus a work in progress.

Currently, all comments are one-liners and thus follow the \\! syntax. However, multi-line comments can be created with

\**
  * @brief Comment
  *
  * More details here.
  * 
  * @param parameter
  * @returns returned variable
  * \

Every function with the override keyword inherits the virtual function's doxygen comment and thus does not need its own docstring unless there are mention-worthy differences.

@akorgor akorgor requested a review from JesusEV November 14, 2023 11:41
@akorgor akorgor merged commit 202d54a into jstapmanns:eprop_feature Nov 22, 2023
@akorgor akorgor deleted the wip-eprop-doxygen branch November 22, 2023 13:36
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.

1 participant