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

Update the documentation of plugins (part 2). #6065

Merged
merged 3 commits into from
Oct 10, 2024

Conversation

bangerth
Copy link
Contributor

@bangerth bangerth commented Oct 9, 2024

In relation to #1775. Follow-up to #6061.

What's left is that I want to look through the code base to see whether we have any plugin systems that are not described in the files in this directory.

Copy link
Member

@gassmoeller gassmoeller left a comment

Choose a reason for hiding this comment

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

Thank you! I like that we now rely more on the doxygen documentation. That should make it easier to maintain the documentation. I found a few small issues, but I'll see if I can apply my suggestions and then merge.

doc/sphinx/user/extending/plugin-types/postprocessors.md Outdated Show resolved Hide resolved
doc/sphinx/user/extending/plugin-types/temp-bc.md Outdated Show resolved Hide resolved
doc/sphinx/user/extending/plugin-types/velocity-bc.md Outdated Show resolved Hide resolved
doc/sphinx/user/extending/plugin-types/velocity-bc.md Outdated Show resolved Hide resolved
doc/sphinx/user/extending/plugin-types/velocity-bc.md Outdated Show resolved Hide resolved
doc/sphinx/user/extending/plugin-types/velocity-bc.md Outdated Show resolved Hide resolved
doc/sphinx/user/extending/plugin-types/velocity-bc.md Outdated Show resolved Hide resolved
doc/sphinx/user/extending/plugin-types/velocity-bc.md Outdated Show resolved Hide resolved
@gassmoeller gassmoeller merged commit b776b39 into geodynamics:main Oct 10, 2024
8 checks passed
@bangerth bangerth deleted the doc-update branch October 10, 2024 16:22
@bangerth
Copy link
Contributor Author

Thanks for the careful reading, and for fixing the many places I apparently missed :-(

And yes, better reference the doxygen documentation because that is always up to date. Many of the duplicated interfaces were no longer up to date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants