Add Health Connect data type documentation - #653
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 10006389-8b26-4ef0-b21f-5ebb7e9d56a3
There was a problem hiding this comment.
Pull request overview
Imports official-source XML documentation into the Android.Health.Connect.DataTypes namespace to replace many To be added. placeholders while keeping existing non-placeholder content intact (and leaving docs/xml/index.xml untouched as stated).
Changes:
- Replaced
To be added.summaries/remarks in many Health Connect DataTypes XML docs with Android reference-derived documentation + required attribution paragraphs. - Added/expanded value/parameter documentation for several enum-like constants and builder APIs (zone offsets, measurement locations, exercise/session metadata, etc.).
- Updated multiple record/builder docs to include Android reference links for traceability.
Reviewed changes
Copilot reviewed 86 out of 86 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/xml/Android.Health.Connect.DataTypes/WheelchairPushesRecord+Builder.xml | Imports builder member docs (zone offsets) and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/WeightRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/Vo2MaxRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/TotalCaloriesBurnedRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/StepsRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/StepsCadenceRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/SpeedRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/SleepStageType.xml | Imports enum value documentation with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/SleepSessionRecord+Stage.xml | Improves property value documentation for stage type. |
| docs/xml/Android.Health.Connect.DataTypes/SleepSessionRecord+Builder.xml | Imports builder docs for notes/stages/title/zone offsets with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/SkinTemperatureRecordMeasurementLocation.xml | Imports measurement-location constant documentation with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/SkinTemperatureRecord+Builder.xml | Imports builder docs for baseline/deltas/measurement location/zone offsets. |
| docs/xml/Android.Health.Connect.DataTypes/SexualActivityRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/RestingHeartRateRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/RespiratoryRateRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/PowerRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/PlannedExerciseStepExerciseCategory.xml | Imports exercise-category constant documentation with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/PlannedExerciseStep.xml | Improves property value documentation for exercise category/type. |
| docs/xml/Android.Health.Connect.DataTypes/PlannedExerciseSessionRecord.xml | Improves property value documentation for session exercise type. |
| docs/xml/Android.Health.Connect.DataTypes/PlannedExerciseBlock+Builder.xml | Imports builder docs for steps/description/repetitions with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/OxygenSaturationRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/OvulationTestResultValue.xml | Imports result constant documentation with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/OvulationTestRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/MindfulnessSessionType.xml | Imports session-type constant documentation with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/MindfulnessSessionRecord+Builder.xml | Imports builder docs for notes/title/zone offsets with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/MindfulnessSessionRecord.xml | Improves property value documentation for mindfulness session type. |
| docs/xml/Android.Health.Connect.DataTypes/Metadata+Builder.xml | Imports builder docs for client IDs/versions/data origin/device/id/recording method with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/Metadata.xml | Improves property value documentation for recording method. |
| docs/xml/Android.Health.Connect.DataTypes/MenstruationPeriodRecord+Builder.xml | Imports builder docs for zone offsets with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/MenstruationFlowRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/MedicalResource.xml | Imports documentation for Parcelable + MedicalResource accessors with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/LeanBodyMassRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/IntermenstrualBleedingRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/HydrationRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/HeightRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/HeartRateVariabilityRmssdRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/HeartRateRecord+Builder.xml | Imports builder docs including constructor/zone offsets with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/HealthRecordingMethod.xml | Imports recording-method constant documentation with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/HealthMealType.xml | Imports meal-type constant documentation with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/FloorsClimbedRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/FhirVersion.xml | Imports Parcelable-related docs + parsing docs with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/FhirResource.xml | Imports FHIR resource docs + Parcelable docs with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/ExerciseSessionRecord.xml | Improves exercise type + RPE value documentation. |
| docs/xml/Android.Health.Connect.DataTypes/ExerciseSegment+Builder.xml | Imports builder docs for RPE/reps/set index/weight with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/ExerciseSegment.xml | Improves value documentation for RPE and set index. |
| docs/xml/Android.Health.Connect.DataTypes/ExerciseRoute+Location+Builder.xml | Imports Location.Builder docs and parameter constraints with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/ExerciseRoute+Location.xml | Imports Parcelable docs + latitude/longitude value constraints with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/ExerciseRoute.xml | Imports Parcelable docs with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/ExerciseLap+Builder.xml | Imports builder docs for lap length with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/ElevationGainedRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/DistanceRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/Device+Builder.xml | Imports builder docs for device manufacturer/model/type with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/DataOrigin+Builder.xml | Imports builder docs for package name with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/CyclingPedalingCadenceRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/CervicalMucusRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/CervicalMucusAppearanceType.xml | Imports appearance constant documentation with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/BoneMassRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/BodyWaterMassRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/BodyTemperatureRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/BodyFatRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/BloodPressureRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/BloodPressureMeasurementLocationType.xml | Imports measurement-location constants with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/BloodPressureBodyPosition.xml | Imports body-position constants with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/BloodGlucoseSpecimenSource.xml | Imports specimen source constants with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/BloodGlucoseRelationToMeal.xml | Imports relation-to-meal constants with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/BloodGlucoseRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/BasalMetabolicRateRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/BasalBodyTemperatureRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/ActivityIntensityType.xml | Imports activity intensity constants with Android reference links and attribution. |
| docs/xml/Android.Health.Connect.DataTypes/ActivityIntensityRecord+Builder.xml | Imports builder docs for start/end zone offsets with Android reference links. |
| docs/xml/Android.Health.Connect.DataTypes/ActivityIntensityRecord.xml | Improves value documentation for intensity type. |
| docs/xml/Android.Health.Connect.DataTypes/ActiveCaloriesBurnedRecord+Builder.xml | Imports zone offset builder docs and Android reference links. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto review. |
dalexsoto
left a comment
There was a problem hiding this comment.
At least 21 Health Connect files leave literal To be added. text at the start of importer-augmented <remarks> blocks, followed only by source/attribution paragraphs. This publishes placeholder text while omitting the descriptive remarks. Please replace those placeholders with the corresponding descriptive sentence and add a full-pattern regression check.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 139c62ae-90bd-4249-a00a-12986d2900f6
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 139c62ae-90bd-4249-a00a-12986d2900f6
|
dalexsoto
left a comment
There was a problem hiding this comment.
All Health Connect augmented remarks now use source-backed prose, and the importer regression check prevents stale placeholder text from recurring.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 139c62ae-90bd-4249-a00a-12986d2900f6
|
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
The merge from main dropped the approved source-backed remarks repair: IsImporterMetadataRepair now removes To be added. but ignores the replacement prose, allowing reference/attribution-only remarks while the regression check still passes. Please restore the prose-preserving implementation and an assertion that verifies the descriptive paragraph remains after repair.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 139c62ae-90bd-4249-a00a-12986d2900f6
|
dalexsoto
left a comment
There was a problem hiding this comment.
docs/xml/Android.Health.Connect.DataTypes/HeartRateRecord+Builder.xml retains the stale HeartRateRecord$Builder(...) reference and adds the correct Builder(...) reference, leaving duplicate links and a broken anchor in the published remarks. Please remove the stale paragraph and cover this $Builder constructor form in the importer cleanup.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 139c62ae-90bd-4249-a00a-12986d2900f6
|
dalexsoto
left a comment
There was a problem hiding this comment.
Nested-constructor cleanup in tools/importer.cs still runs only through AddSourceDocumentationIfSafe after an owner has changed, so 45 stale $Builder(...) anchors remain across 44 changed XML files (for example, ActiveCaloriesBurnedRecord+Builder.xml:80). The official pages expose the corresponding Builder(...) anchors, and a production dry run skips these owners when source documentation is empty. Please run stale-link normalization independently of placeholder/source-prose replacement and regenerate all affected references.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 139c62ae-90bd-4249-a00a-12986d2900f6
|
dalexsoto
left a comment
There was a problem hiding this comment.
RemoveStaleNestedConstructorLinks deletes each stale reference paragraph instead of normalizing it in place. This head removes 64 links but restores only seven owners with importable source docs, leaving 57 constructors across 56 files with attribution-only remarks even though every normalized Builder(...) anchor exists on the official page. Please rewrite each stale URL/label to its normalized anchor and add a stale-only regression test that requires the corrected member reference to remain.
Summary
Remaining placeholders
The final offline importer scan found no further exact matches. It conservatively skipped 2,427 placeholders: 1,614 missing member registrations, 404 non-meaningful source channels, 318 empty source documentation entries, 58 missing type registrations, 30 missing return documentation entries, and 3 missing type documentation entries.
Closes #111