Skip to content

Document geomagnetic field measurements - #641

Merged
jonathanpeppers merged 1 commit into
mainfrom
jonathanpeppers-document-android-hardware-api
Aug 18, 2026
Merged

Document geomagnetic field measurements#641
jonathanpeppers merged 1 commit into
mainfrom
jonathanpeppers-document-android-hardware-api

Conversation

@jonathanpeppers

@jonathanpeppers jonathanpeppers commented Aug 17, 2026

Copy link
Copy Markdown
Member

Summary

  • Add summaries for GeomagneticField declination and inclination properties.
  • Document total and horizontal field strength properties.
  • Document the northward, eastward, and downward component methods.

Refs #109

Sources

Validation

  • [xml](Get-Content -Raw docs\xml\Android.Hardware\GeomagneticField.xml) - passed.
  • git diff --check HEAD^ HEAD - passed.
  • Verified docs\xml\Android.Hardware\GeomagneticField.xml retains CRLF line endings: 480 CRLF sequences, zero bare LF sequences, and a final CRLF.
  • Verified the seven edited summaries against the pinned AOSP source anchors above.
  • rg -i -o 'to be added' docs\xml\Android.Hardware --glob '*.xml' | Measure-Object - 516 scoped placeholders remain; none were added.

Add summaries for the public field component, strength, declination, and inclination members based on their Android source documentation.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings August 17, 2026 13:44

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The geomagnetic measurement definitions, units, NED axes, managed signatures, and generated documentation are correct.

auto-merge was automatically disabled August 18, 2026 01:15

Pull request was closed

@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) August 18, 2026 01:15
@jonathanpeppers
jonathanpeppers merged commit 6aa58d7 into main Aug 18, 2026
3 of 4 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-android-hardware-api branch August 18, 2026 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants