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

Added Doxygen structure for C++ files #11

Merged
merged 3 commits into from
Oct 30, 2024

Conversation

jbrzensk
Copy link
Collaborator

I added basic headers for all files and basic oxygen structure for the mimetic operators.
Some of the code is self-explanatory and does not need explanation ( like operators.h).

Some comments, like the interpolators, need more explanation, like why/when the second-type interpolators are used.

This is a good starting block for future Doxygen edits.

@jbrzensk jbrzensk self-assigned this Oct 17, 2024
@jbrzensk jbrzensk added the documentation Improvements or additions to documentation label Oct 17, 2024
@valeriabarra
Copy link
Collaborator

Thanks @jbrzensk !

Hey @pritkc , do you mind checking out this branch DOCUMENTATION_doxygen_for_cpp and testing the Doxygen changes that Jared is introduing? Let us know if you have specific comments/questions in the PR Review tab.

Thank you!

@pritkc
Copy link
Collaborator

pritkc commented Oct 17, 2024

Thanks @jbrzensk !

Hey @pritkc , do you mind checking out this branch DOCUMENTATION_doxygen_for_cpp and testing the Doxygen changes that Jared is introduing? Let us know if you have specific comments/questions in the PR Review tab.

Thank you!

I've added it to my list, thanks

@jbrzensk jbrzensk requested a review from aboada October 18, 2024 17:35
src/mole_C++/utils.cpp Outdated Show resolved Hide resolved
src/mole_C++/utils.cpp Outdated Show resolved Hide resolved
src/mole_C++/utils.cpp Outdated Show resolved Hide resolved
src/mole_C++/utils.cpp Outdated Show resolved Hide resolved
src/mole_C++/operators.h Outdated Show resolved Hide resolved
src/mole_C++/laplacian.h Outdated Show resolved Hide resolved
@valeriabarra
Copy link
Collaborator

Thank you @jbrzensk for your work! I was able to test locally and visualize the generated html files. Nice job!

@jbrzensk jbrzensk merged commit c78ef46 into master Oct 30, 2024
9 checks passed
@jbrzensk jbrzensk deleted the DOCUMENTATION_doxygen_for_cpp branch October 30, 2024 17:05
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.

4 participants