Skip to content

Add Health Connect data type documentation #653

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

Open
jonathanpeppers wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add Health Connect data type documentation #653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3dddd18
Add Health Connect data type documentation
jonathanpeppers Aug 18, 2026
8ac461a
Address Health Connect documentation review
jonathanpeppers Aug 19, 2026
e411e80
Repair importer-generated remarks placeholders
jonathanpeppers Aug 19, 2026
94287ad
Add Health Connect remarks regression check
jonathanpeppers Aug 19, 2026
0e01349
Merge main into Health Connect documentation updates
jonathanpeppers Aug 19, 2026
2fb246c
Preserve prose in importer metadata repairs
jonathanpeppers Aug 19, 2026
1466eb8
Clean stale nested builder references
jonathanpeppers Aug 19, 2026
7a58904
Clean stale nested constructor links
jonathanpeppers Aug 19, 2026
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
37 changes: 24 additions & 13 deletions docs/xml/Android.Health.Connect.DataTypes/ActiveCaloriesBurnedRecord+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,6 @@
<param name="energy">Energy in <c>Energy</c> unit. Required field. Valid range: 0-1000000 kcal.</param>
<summary>To be added.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/health/connect/datatypes/ActiveCaloriesBurnedRecord.Builder#ActiveCaloriesBurnedRecord$Builder(android.health.connect.datatypes.Metadata,%20java.time.Instant,%20java.time.Instant,%20android.health.connect.datatypes.units.Energy)" title="Reference documentation">Java documentation for <code>android.health.connect.datatypes.ActiveCaloriesBurnedRecord.Builder.ActiveCaloriesBurnedRecord$Builder(android.health.connect.datatypes.Metadata, java.time.Instant, java.time.Instant, android.health.connect.datatypes.units.Energy)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
Expand Down Expand Up @@ -154,9 +149,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Sets the end zone offset of this record to system default.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>Sets the end zone offset of this record to system default.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/ActiveCaloriesBurnedRecord.Builder#clearEndZoneOffset()" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.ActiveCaloriesBurnedRecord.Builder.clearEndZoneOffset</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ClearStartZoneOffset">
Expand Down Expand Up @@ -184,9 +183,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Sets the start zone offset of this record to system default.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>Sets the start zone offset of this record to system default.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/ActiveCaloriesBurnedRecord.Builder#clearStartZoneOffset()" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.ActiveCaloriesBurnedRecord.Builder.clearStartZoneOffset</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down Expand Up @@ -246,9 +249,13 @@
</Parameters>
<Docs>
<param name="endZoneOffset">To be added.</param>
<summary>To be added.</summary>
<summary>Sets the zone offset of the user when the activity ended</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>Sets the zone offset of the user when the activity ended</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/ActiveCaloriesBurnedRecord.Builder#setEndZoneOffset(java.time.ZoneOffset)" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.ActiveCaloriesBurnedRecord.Builder.setEndZoneOffset</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetStartZoneOffset">
Expand Down Expand Up @@ -279,9 +286,13 @@
</Parameters>
<Docs>
<param name="startZoneOffset">To be added.</param>
<summary>To be added.</summary>
<summary>Sets the zone offset of the user when the activity started</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>Sets the zone offset of the user when the activity started</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/ActiveCaloriesBurnedRecord.Builder#setStartZoneOffset(java.time.ZoneOffset)" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.ActiveCaloriesBurnedRecord.Builder.setStartZoneOffset</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand Down
21 changes: 12 additions & 9 deletions docs/xml/Android.Health.Connect.DataTypes/ActivityIntensityRecord+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,6 @@
<param name="activityIntensityType">To be added.</param>
<summary>To be added.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/health/connect/datatypes/ActivityIntensityRecord.Builder#ActivityIntensityRecord$Builder(android.health.connect.datatypes.Metadata,%20java.time.Instant,%20java.time.Instant,%20int)" title="Reference documentation">Java documentation for <code>android.health.connect.datatypes.ActivityIntensityRecord.Builder.ActivityIntensityRecord$Builder(android.health.connect.datatypes.Metadata, java.time.Instant, java.time.Instant, int)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
Expand Down Expand Up @@ -187,9 +182,13 @@
</Parameters>
<Docs>
<param name="endZoneOffset">To be added.</param>
<summary>To be added.</summary>
<summary>Sets the ZoneOffset of the user when the activity ended.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>Sets the ZoneOffset of the user when the activity ended. Defaults to the system zone offset if not set.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/ActivityIntensityRecord.Builder#setEndZoneOffset(java.time.ZoneOffset)" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.ActivityIntensityRecord.Builder.setEndZoneOffset</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetStartZoneOffset">
Expand Down Expand Up @@ -220,9 +219,13 @@
</Parameters>
<Docs>
<param name="startZoneOffset">To be added.</param>
<summary>To be added.</summary>
<summary>Sets the ZoneOffset of the user when the activity started.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>Sets the ZoneOffset of the user when the activity started. Defaults to the system zone offset if not set.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/ActivityIntensityRecord.Builder#setStartZoneOffset(java.time.ZoneOffset)" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.ActivityIntensityRecord.Builder.setStartZoneOffset</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand Down
2 changes: 1 addition & 1 deletion docs/xml/Android.Health.Connect.DataTypes/ActivityIntensityRecord.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
</ReturnValue>
<Docs>
<summary>Returns the type of the activity intensity.</summary>
<value>To be added.</value>
<value>Value is one of the following: ACTIVITY_INTENSITY_TYPE_MODERATE ACTIVITY_INTENSITY_TYPE_VIGOROUS</value>
<remarks>
<para>Returns the type of the activity intensity.</para>
<para>
Expand Down
12 changes: 10 additions & 2 deletions docs/xml/Android.Health.Connect.DataTypes/ActivityIntensityType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para>Moderate activity intensity.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/ActivityIntensityRecord#ACTIVITY_INTENSITY_TYPE_MODERATE" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.ActivityIntensityRecord.ACTIVITY_INTENSITY_TYPE_MODERATE</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</summary>
</Docs>
</Member>
<Member MemberName="Vigorous">
Expand Down Expand Up @@ -68,7 +72,11 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para>Vigorous activity intensity.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/ActivityIntensityRecord#ACTIVITY_INTENSITY_TYPE_VIGOROUS" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.ActivityIntensityRecord.ACTIVITY_INTENSITY_TYPE_VIGOROUS</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</summary>
</Docs>
</Member>
</Members>
Expand Down
21 changes: 12 additions & 9 deletions docs/xml/Android.Health.Connect.DataTypes/BasalBodyTemperatureRecord+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,6 @@
0-100 Celsius degrees.</param>
<summary>To be added.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/health/connect/datatypes/BasalBodyTemperatureRecord.Builder#BasalBodyTemperatureRecord$Builder(android.health.connect.datatypes.Metadata,%20java.time.Instant,%20int,%20android.health.connect.datatypes.units.Temperature)" title="Reference documentation">Java documentation for <code>android.health.connect.datatypes.BasalBodyTemperatureRecord.Builder.BasalBodyTemperatureRecord$Builder(android.health.connect.datatypes.Metadata, java.time.Instant, int, android.health.connect.datatypes.units.Temperature)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
Expand Down Expand Up @@ -163,9 +158,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Sets the zone offset of this record to system default.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>Sets the zone offset of this record to system default.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/BasalBodyTemperatureRecord.Builder#clearZoneOffset()" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.BasalBodyTemperatureRecord.Builder.clearZoneOffset</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down Expand Up @@ -225,9 +224,13 @@
</Parameters>
<Docs>
<param name="zoneOffset">To be added.</param>
<summary>To be added.</summary>
<summary>Sets the zone offset of the user when the activity happened</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>Sets the zone offset of the user when the activity happened</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/health/connect/datatypes/BasalBodyTemperatureRecord.Builder#setZoneOffset(java.time.ZoneOffset)" title="Reference documentation">Android reference for <code>android.health.connect.datatypes.BasalBodyTemperatureRecord.Builder.setZoneOffset</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand Down
Loading