feature: Documentation and proto changes. (#5)

- feature: Added detailed documentation to all `.proto` files to describe the purpose and expected use of each message.
- feature: Added `csharp_namespace` option to the `proto` files to specify the C# namespace for generated files.
- feature: Added `map<string, string> extensions` to the `entity_metadata.proto` file to allow for custom metadata to be added to entities.
- debt: Changed `option objc_class_prefix` to `TPB` to match the project name.

CHANGELOG/CHANGELOG-1.x.md

@@ -17,6 +17,22 @@ Date format: `YYYY-MM-DD`
 ### Fixed
 ### Security
 
+---
+## [1.23.0] - 2024-11-17
+
+### Added
+- **FEATURE:** Added detailed documentation to all `.proto` files to describe the purpose and expected use of each message.
+- **FEATURE:** Added `csharp_namespace` option to the `protoc` command to specify the C# namespace for generated files.
+- **FEATURE:** Added `map<string, string> extensions` to the `entity_metadata.proto` file to allow for custom metadata to be added to entities.
+
+### Changed
+- **DEBT:** Changed `option objc_class_prefix` to `TPB` to match the project name.
+
+### Deprecated
+### Removed
+### Fixed
+### Security
+
 ---
 ## [1.22.0] - 2024-11-17
 
@@ -29,7 +45,8 @@ Date format: `YYYY-MM-DD`
 ### Fixed
 ### Security
 
-[Unreleased]: https://github.com/sixafter/nanoid/compare/v1.22.0..HEAD
+[Unreleased]: https://github.com/sixafter/nanoid/compare/v1.23.0..HEAD
+[1.23.0]: https://github.com/sixafter/nanoid/compare/v1.22.0...v1.23.0
 [1.22.0]: https://github.com/sixafter/nanoid/compare/v1.0.1...v1.22.0
 
 [MUST]: https://datatracker.ietf.org/doc/html/rfc2119

compass_heading.proto

@@ -1,5 +1,8 @@
 // Copyright 2020-2024 SIX AFTER, INC (SIX AFTER)
 //
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: SIX AFTER, INC (SIX AFTER)
+//
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -12,41 +15,56 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-syntax="proto3";
+syntax = "proto3";
 
-package types;
-option go_package="github.com/sixafter/types;types";
+package sixafter.types;
 
+option go_package = "github.com/sixafter/types;types";
 option cc_enable_arenas = true;
 option java_package = "com.sixafter.types";
 option java_multiple_files = true;
 option java_outer_classname = "CompassHeadingProto";
-option objc_class_prefix = "TYP";
+option objc_class_prefix = "TPB";
+option csharp_namespace = "SixAfter.Types.WellKnownTypes";
 
 import "google/protobuf/timestamp.proto";
 
-// The heading of an object in the Compass Geodetic System (CGS).
+// The `CompassHeading` message represents the orientation of an object
+// in the Compass Geodetic System (CGS). This can be used in geolocation
+// systems, navigation tools, or applications requiring orientation data.
 message CompassHeading {
 
   // The heading (measured in degrees) relative to magnetic north.
+  // Values range from 0 to 360, where 0 indicates north, 90 indicates east,
+  // 180 indicates south, and 270 indicates west.
   float magnetic_heading = 1;
 
   // The heading (measured in degrees) relative to true north.
+  // This compensates for the local magnetic declination.
+  // Similar to `magnetic_heading`, values range from 0 to 360.
   float true_heading = 2;
 
   // The maximum deviation (measured in degrees) between the reported heading
-  // and the true geomagnetic heading.
+  // and the true geomagnetic heading. A lower value indicates higher accuracy.
+  // This property is essential for assessing the reliability of the heading data.
   float heading_accuracy = 3;
 
-  // The time at which this heading was determined.
+  // The time at which this heading measurement was taken.
+  // This is useful for correlating heading data with other time-based
+  // measurements or events.
   google.protobuf.Timestamp timestamp = 4;
 
-  // The geomagnetic data (measured in microteslas) for the x-axis.
+  // The geomagnetic field strength (measured in microteslas) along the x-axis.
+  // This represents the horizontal magnetic component and can be used to derive
+  // the magnetic field vector in combination with `y` and `z`.
   float x = 5;
 
-  // The geomagnetic data (measured in microteslas) for the y-axis.
+  // The geomagnetic field strength (measured in microteslas) along the y-axis.
+  // This represents the horizontal magnetic component perpendicular to the `x`-axis.
   float y = 6;
 
-  // The geomagnetic data (measured in microteslas) for the z-axis.
+  // The geomagnetic field strength (measured in microteslas) along the z-axis.
+  // This represents the vertical magnetic component and is crucial for
+  // determining the three-dimensional magnetic vector.
   float z = 7;
-}
+}