Add Doxygen documentation to core and OOP wrapper routines#51
Merged
Conversation
Add structured Doxygen documentation to 8 routines in fitpack_core.F90 that were missing !> @brief blocks: fpader, fpched, fpchep, fpclos_reset_interp, fpperi_reset_interp, root_finding_iterate, new_knot_dimension, fpsuev. All 117 routines now have full Doxygen headers with MathJax equations, @param directions, and @see book refs. Update the documentation plan to mark Phases A, B, and D as complete.
Add @brief documentation with @param, @return, and @see cross-references to 152 previously undocumented methods across 10 OOP wrapper modules (curves, convex curves, parametric, surfaces, grid surfaces, parametric surfaces, polar, gridded polar, spheres, gridded sphere). Total @brief count in OOP files rises from 32 to 184.
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
1 participant
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.
Summary
@briefblocks to all previously undocumented routines infitpack_core.F90and clean up the Doxygen plan document@briefblocks with@param,@return, and@seecross-references to 152 OOP wrapper methods across 10 domain modules (curves, convex curves, parametric, surfaces, grid surfaces, parametric surfaces, polar, gridded polar, spheres, gridded sphere)@briefcount in OOP files rises from 32 to 184; 12 files changed, +1018/−408 linesTest plan
fpm buildcompiles successfullyfpm test— all 59 tests passgrep -c '!> @brief'confirms coverage increase across all 10 OOP files