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

Chogan/api docs #447

Merged
merged 13 commits into from
Sep 16, 2022
Merged

Chogan/api docs #447

merged 13 commits into from
Sep 16, 2022

Conversation

ChristopherHogan
Copy link
Collaborator

@ChristopherHogan ChristopherHogan commented Sep 16, 2022 •
edited
Loading

Closes #189.

  • Documents all public API classes and methods.
  • Delete unused file api/id.h.
  • Set SORT_MEMBER_DOCS=NO in Doxyfile.in so that the doxygen \overload command works properly.
  • Begin the process of converting all doxygen special commands from @ to \. There was a mixture of the two. We need to settle on one, and I chose \ because that's what the HDF5 documentation uses.

@ChristopherHogan ChristopherHogan added the documentation Improvements or additions to documentation label Sep 16, 2022
@coveralls
Copy link

Coverage Status

Coverage decreased (-0.3%) to 81.62% when pulling 66c7248 on chogan/api_docs into ac60625 on master.

@ChristopherHogan ChristopherHogan merged commit d3b1741 into master Sep 16, 2022
@ChristopherHogan ChristopherHogan deleted the chogan/api_docs branch September 16, 2022 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document the public API
2 participants
@ChristopherHogan @coveralls