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.

Sign up for GitHub

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

Jump to bottom

[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
Merged

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

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

m-fila
m-fila reviewed Apr 2, 2024
View reviewed changes
include/podio/Frame.h Outdated Show resolved Hide resolved
include/podio/RNTupleWriter.h Outdated Show resolved Hide resolved
include/podio/ROOTWriter.h Outdated Show resolved Hide resolved
@tmadlener @m-fila
Fix typos
592a8d7 
Co-authored-by: Mateusz Jakub Fila <37295697+m-fila@users.noreply.github.com>
andresailer
andresailer reviewed Apr 2, 2024
View reviewed changes
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.

include/podio/CollectionBufferFactory.h Outdated Show resolved Hide resolved
include/podio/DatamodelRegistry.h Outdated Show resolved Hide resolved
include/podio/Frame.h Outdated Show resolved Hide resolved
include/podio/Frame.h Outdated Show resolved Hide resolved
include/podio/GenericParameters.h Outdated Show resolved Hide resolved
andresailer
andresailer reviewed Apr 3, 2024
View reviewed changes
include/podio/ROOTLegacyReader.h Outdated Show resolved Hide resolved
include/podio/ROOTReader.h Outdated Show resolved Hide resolved
include/podio/ROOTWriter.h Outdated Show resolved Hide resolved
include/podio/RelationRange.h Outdated Show resolved Hide resolved
include/podio/SIOWriter.h Outdated Show resolved Hide resolved
include/podio/utilities/TypeHelpers.h Outdated Show resolved Hide resolved
include/podio/utilities/TypeHelpers.h Outdated Show resolved Hide resolved
include/podio/utilities/TypeHelpers.h Outdated Show resolved Hide resolved
podioVersion.in.h Outdated Show resolved Hide resolved
podioVersion.in.h Outdated Show resolved Hide resolved
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andresailer andresailer andresailer left review comments

@m-fila m-fila m-fila left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tmadlener @andresailer @m-fila