Skip to content

Document geomagnetic field measurements #641

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.

Sign up for GitHub

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

Merged
jonathanpeppers merged 1 commit into from
Aug 18, 2026
Merged

Document geomagnetic field measurements #641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 7 additions & 14 deletions docs/xml/Android.Hardware/GeomagneticField.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,7 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
</summary>
<summary>Gets the declination of the horizontal magnetic field from true north, in degrees.</summary>
<value>The declination of the horizontal component of the magnetic
field from true north, in degrees (i.e. positive means the
magnetic field is rotated east that much from true north).</value>
Expand Down Expand Up @@ -178,8 +177,7 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
</summary>
<summary>Gets the total magnetic field strength, in nanoteslas.</summary>
<value>Total field strength in nanoteslas.</value>
<remarks>
<para>
Expand Down Expand Up @@ -217,8 +215,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>
</summary>
<summary>Returns the northward component of the magnetic field, in nanoteslas.</summary>
<returns>The X (northward) component of the magnetic field in nanoteslas.</returns>
<remarks>
<para>
Expand Down Expand Up @@ -256,8 +253,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>
</summary>
<summary>Returns the eastward component of the magnetic field, in nanoteslas.</summary>
<returns>The Y (eastward) component of the magnetic field in nanoteslas.</returns>
<remarks>
<para>
Expand Down Expand Up @@ -295,8 +291,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>
</summary>
<summary>Returns the downward component of the magnetic field, in nanoteslas.</summary>
<returns>The Z (downward) component of the magnetic field in nanoteslas.</returns>
<remarks>
<para>
Expand Down Expand Up @@ -333,8 +328,7 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
</summary>
<summary>Gets the horizontal component of the magnetic field strength, in nanoteslas.</summary>
<value>Horizontal component of the field strength in nanoteslas.</value>
<remarks>
<para>
Expand Down Expand Up @@ -371,8 +365,7 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
</summary>
<summary>Gets the inclination of the magnetic field, in degrees.</summary>
<value>The inclination of the magnetic field in degrees -- positive
means the magnetic field is rotated downwards.</value>
<remarks>
Expand Down
Loading