Updated the comments on the Swift-Hohenberg solver code so that they look better on the website.#236
Merged
bangerth merged 3 commits intodealii:masterfrom Jan 17, 2026
Merged
Conversation
added 2 commits
January 14, 2026 12:18
bangerth
reviewed
Jan 16, 2026
Member
bangerth
left a comment
bangerth
left a comment
There was a problem hiding this comment.
Yes, if these were regular classes and functions, it would have been appropriate to use doxygen mark-up. But we first run everything that's part of the code gallery through scripts that shows both code and commentary as text, and so doxygen doesn't know what code the special mark-ups like @brief or @param actually attach to (because it sees the code only as text).
Let me know once you've broken the long lines and we can merge.
Comment on lines
74
to
76
| // This function warps points on a cylindrical mesh by cosine wave along the central axis. | ||
| // We use this function to generate the "sinusoid" mesh, which is the surface of revolution | ||
| // bounded by the cosine wave. spacedim is the dimension of the embedding space, which is where the input point lives. p is the input point to be translated. The return is a translated point in the same dimensional space. This is the new point on the mesh. |
Member
There was a problem hiding this comment.
Here and below, would you mind breaking comments to ~80 characters per line?
bangerth
approved these changes
Jan 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When I originally wrote the documentation for this code, I tried to use syntax for doxygen, but it didn't really look right on the webpage. I've swapped all the syntax for plain comments, and it looks much better now.