Add XML documentation and replace BGGM attributions with NOAA#28
Merged
StreckerCM merged 5 commits intopreviewfrom Feb 5, 2026
Merged
Add XML documentation and replace BGGM attributions with NOAA#28StreckerCM merged 5 commits intopreviewfrom
StreckerCM merged 5 commits intopreviewfrom
Conversation
Add /// <summary> XML documentation comments to all public classes, constructors, methods, properties, and enums across the GeoMagSharp library. This covers 15 files including GeoMag, Calculator, Units, ExtensionMethods, and all Model classes (Configuration, Coordinates, Magnetic, Results). Closes #11 Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
The BGGM coefficient file is no longer freely available from the British Geological Survey. Updated Calculator.cs header, class documentation, and enum descriptions to reference the NOAA World Magnetic Model instead. Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
StreckerCM
changed the title
- Add class-level XML doc to ModelReader - Update ModelReader.cs file header (was still referencing FileReader.cs) - Fix XML doc formatting on all exception classes (///<summary> -> /// <summary>) - Correct inaccurate exception descriptions (several had copy-paste errors) - Update README.md credits to reference NOAA WMM instead of BGS Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
- Fix Longitude copy constructor parameter type (Latitude -> Longitude) - Fix MagneticModel copy constructor copying from self instead of other - Fix Distance.ToString returning "mi" for kilometer instead of "km" - Clean up GeoMag.cs file header (trailing whitespace, empty fields) Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
…documentation # Conflicts: # GeoMagSharp/ModelReader.cs
StreckerCM
added a commit
that referenced
this pull request
Feb 13, 2026
- Add XML documentation comments to all public APIs across GeoMagSharp library - Replace BGGM/BGS attributions with NOAA WMM references - Fix exception class documentation (formatting and inaccurate descriptions) - Fix Longitude copy constructor parameter type (Latitude -> Longitude) - Fix MagneticModel copy constructor copying from self instead of other - Fix Distance.ToString returning "mi" for kilometer instead of "km" - Clean up file headers (trailing whitespace, incorrect filenames, empty fields) - Update README.md credits Closes #11
2 tasks
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
///XML documentation comments to all public APIs across the GeoMagSharp libraryCloses #11
Attribution Changes
Algorithm.BGSdescription from "British Geological Survey" to "Default spherical harmonic algorithm"Bug Fixes
Latitudeparameter instead ofLongitudeLongitudeSharmCoeff.AddRange(SharmCoeff)copied from selfSharmCoeff.AddRange(other.SharmCoeff)Distance.ToString(Unit.kilometer)returned"mi"instead of"km""km"XML Documentation Changes
File Header Cleanup
Test plan