Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[doc] Homogenize the format of the c++ docstrings and add more doxygen tags in some places #574

Merged
merged 15 commits into from
Apr 9, 2024

Conversation

tmadlener
Copy link
Collaborator

BEGINRELEASENOTES

  • Make all docstrings of c++ classes use the /// style (instead of the previous mix of /// and /**/`.
  • Extend and improve existing docstrings (e.g. add @params and @returns tags, add information or reword).

ENDRELEASENOTES

Co-authored-by: Mateusz Jakub Fila <37295697+m-fila@users.noreply.github.com>
Copy link
Member

@andresailer andresailer left a comment

Choose a reason for hiding this comment

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

some typos, some grammar. Haven't read everything yet.

@tmadlener tmadlener merged commit b94cc63 into AIDASoft:master Apr 9, 2024
18 checks passed
@tmadlener tmadlener deleted the better-docstrings branch April 9, 2024 08:21
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants