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

42 defining specific doxygen APIs #43

Closed
wants to merge 15 commits into from

Conversation

andrewcoughtrie
Copy link
Collaborator

@andrewcoughtrie andrewcoughtrie commented Aug 9, 2022

Defining a concrete API within the Doxygen docs.

@andrewcoughtrie andrewcoughtrie added the documentation Improvements or additions to documentation label Aug 9, 2022
@andrewcoughtrie andrewcoughtrie self-assigned this Aug 9, 2022
@andrewcoughtrie andrewcoughtrie linked an issue Aug 9, 2022 that may be closed by this pull request
@andrewcoughtrie
Copy link
Collaborator Author

I've updated the Doxygen output to produce a properly defined API for C++,C, and Fortran. This contains just the information for a user.

@andrewcoughtrie andrewcoughtrie marked this pull request as ready for review August 25, 2022 17:15
@andrewcoughtrie andrewcoughtrie added the ready for review ready for review label Aug 25, 2022
!-----------------------------------------------------------------------------
! Contained functions / subroutines
!-----------------------------------------------------------------------------
contains

!> @ingroup FortranAPI
Copy link
Collaborator

Choose a reason for hiding this comment

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

Was the indentation intentional, here? (Same comment applies to other comment blocks for the FortranAPI.)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've changed the indentation so it all lines up now.

@mo-mglover
Copy link
Collaborator

General question: how do I see the documentation for parts of the code other than the API?

@andrewcoughtrie
Copy link
Collaborator Author

General question: how do I see the documentation for parts of the code other than the API?

You should just be able to click on the classes tab at the top of the Doxygen output and it will show you the generated stuff for all the other classes.

@TeranIvy
Copy link
Collaborator

Happy to review once it is up-to-date with the main.

@TeranIvy TeranIvy self-requested a review February 10, 2023 10:54
@andrewcoughtrie andrewcoughtrie added in progress and removed ready for review ready for review labels Aug 1, 2023
@andrewcoughtrie andrewcoughtrie marked this pull request as draft August 1, 2023 12:19
@andrewcoughtrie andrewcoughtrie marked this pull request as ready for review September 22, 2023 14:28
@andrewcoughtrie andrewcoughtrie marked this pull request as draft September 22, 2023 14:30
@andrewcoughtrie andrewcoughtrie deleted the 42-defining-specific-doxygen-apis branch June 7, 2024 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Defining specific Doxygen APIs
3 participants