Merge pull request #1040 from CesiumGS/doxygen-coverage

Fix all Doxygen warnings
CesiumGS · Dec 18, 2024 · 9a95ae6 · 9a95ae6
2 parents cc0d6c5 + 4fb3063
commit 9a95ae6
Show file tree

Hide file tree

Showing 302 changed files with 3,893 additions and 573 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,6 +2,10 @@
 
 ### ? - ?
 
+##### Breaking Changes :mega:
+
+- Removed unused types `JsonValueMissingKey` and `JsonValueNotRealValue` from `CesiumUtility`.
+
 ##### Additions :tada:
 
 - Added `offset` getter to `AccessorView`.
@@ -1123,4 +1127,4 @@ In addition to the above, this release updates the following third-party librari
 
 ### v0.1.0 - 2021-03-30
 
-- Initial release.
+- Initial release.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -52,7 +52,7 @@ Before we can review a pull request, we require a signed Contributor License Agr
 - [individuals](https://docs.google.com/forms/d/e/1FAIpQLScU-yvQdcdjCFHkNXwdNeEXx5Qhu45QXuWX_uF5qiLGFSEwlA/viewform) and
 - [corporations](https://docs.google.com/forms/d/e/1FAIpQLSeYEaWlBl1tQEiegfHMuqnH9VxyfgXGyIw13C2sN7Fj3J3GVA/viewform).
 
-This only needs to be completed once, and enables contributions to all of the projects under the [CesiumGS](https://github.com/CesiumGS) organization, including Cesium Native. The CLA ensures you retain copyright to your contributions, and provides us the right to use, modify, and redistribute your contributions using the [Apache 2.0 License](LICENSE.md).
+This only needs to be completed once, and enables contributions to all of the projects under the [CesiumGS](https://github.com/CesiumGS) organization, including Cesium Native. The CLA ensures you retain copyright to your contributions, and provides us the right to use, modify, and redistribute your contributions using the [Apache 2.0 License](LICENSE).
 
 If you have any questions, feel free to reach out to [email protected]!
 

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Asset.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Asset.h
@@ -13,6 +13,9 @@ namespace Cesium3DTiles {
  * @brief Metadata about the entire tileset.
  */
 struct CESIUM3DTILES_API Asset final : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Asset";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Availability.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Availability.h
@@ -14,15 +14,20 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API Availability final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Availability";
 
   /**
    * @brief Known values for Integer indicating whether all of the elements are
    * available (1) or all are unavailable (0).
    */
   struct Constant {
+    /** @brief UNAVAILABLE (`0`) */
     static constexpr int32_t UNAVAILABLE = 0;
 
+    /** @brief AVAILABLE (`1`) */
     static constexpr int32_t AVAILABLE = 1;
   };
 

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/BoundingVolume.h b/Cesium3DTiles/generated/include/Cesium3DTiles/BoundingVolume.h
@@ -15,6 +15,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API BoundingVolume final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "BoundingVolume";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/BufferSpec.h b/Cesium3DTiles/generated/include/Cesium3DTiles/BufferSpec.h
@@ -15,6 +15,9 @@ namespace Cesium3DTiles {
  * subtree file, or an external buffer referenced by a URI.
  */
 struct CESIUM3DTILES_API BufferSpec : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Buffer";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/BufferView.h b/Cesium3DTiles/generated/include/Cesium3DTiles/BufferView.h
@@ -15,6 +15,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API BufferView final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "BufferView";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Class.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Class.h
@@ -15,6 +15,9 @@ namespace Cesium3DTiles {
  * @brief A class containing a set of properties.
  */
 struct CESIUM3DTILES_API Class final : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Class";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/ClassProperty.h b/Cesium3DTiles/generated/include/Cesium3DTiles/ClassProperty.h
@@ -16,30 +16,43 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API ClassProperty final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "ClassProperty";
 
   /**
    * @brief Known values for The element type.
    */
   struct Type {
+    /** @brief `SCALAR` */
     inline static const std::string SCALAR = "SCALAR";
 
+    /** @brief `VEC2` */
     inline static const std::string VEC2 = "VEC2";
 
+    /** @brief `VEC3` */
     inline static const std::string VEC3 = "VEC3";
 
+    /** @brief `VEC4` */
     inline static const std::string VEC4 = "VEC4";
 
+    /** @brief `MAT2` */
     inline static const std::string MAT2 = "MAT2";
 
+    /** @brief `MAT3` */
     inline static const std::string MAT3 = "MAT3";
 
+    /** @brief `MAT4` */
     inline static const std::string MAT4 = "MAT4";
 
+    /** @brief `STRING` */
     inline static const std::string STRING = "STRING";
 
+    /** @brief `BOOLEAN` */
     inline static const std::string BOOLEAN = "BOOLEAN";
 
+    /** @brief `ENUM` */
     inline static const std::string ENUM = "ENUM";
   };
 
@@ -48,24 +61,34 @@ struct CESIUM3DTILES_API ClassProperty final
    * for `SCALAR`, `VECN`, and `MATN` types, and disallowed for other types.
    */
   struct ComponentType {
+    /** @brief `INT8` */
     inline static const std::string INT8 = "INT8";
 
+    /** @brief `UINT8` */
     inline static const std::string UINT8 = "UINT8";
 
+    /** @brief `INT16` */
     inline static const std::string INT16 = "INT16";
 
+    /** @brief `UINT16` */
     inline static const std::string UINT16 = "UINT16";
 
+    /** @brief `INT32` */
     inline static const std::string INT32 = "INT32";
 
+    /** @brief `UINT32` */
     inline static const std::string UINT32 = "UINT32";
 
+    /** @brief `INT64` */
     inline static const std::string INT64 = "INT64";
 
+    /** @brief `UINT64` */
     inline static const std::string UINT64 = "UINT64";
 
+    /** @brief `FLOAT32` */
     inline static const std::string FLOAT32 = "FLOAT32";
 
+    /** @brief `FLOAT64` */
     inline static const std::string FLOAT64 = "FLOAT64";
   };
 

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/ClassStatistics.h b/Cesium3DTiles/generated/include/Cesium3DTiles/ClassStatistics.h
@@ -18,6 +18,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API ClassStatistics final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "ClassStatistics";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Content.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Content.h
@@ -17,6 +17,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API Content final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Content";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Enum.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Enum.h
@@ -15,26 +15,37 @@ namespace Cesium3DTiles {
  * @brief An object defining the values of an enum.
  */
 struct CESIUM3DTILES_API Enum final : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Enum";
 
   /**
    * @brief Known values for The type of the integer enum value.
    */
   struct ValueType {
+    /** @brief `INT8` */
     inline static const std::string INT8 = "INT8";
 
+    /** @brief `UINT8` */
     inline static const std::string UINT8 = "UINT8";
 
+    /** @brief `INT16` */
     inline static const std::string INT16 = "INT16";
 
+    /** @brief `UINT16` */
     inline static const std::string UINT16 = "UINT16";
 
+    /** @brief `INT32` */
     inline static const std::string INT32 = "INT32";
 
+    /** @brief `UINT32` */
     inline static const std::string UINT32 = "UINT32";
 
+    /** @brief `INT64` */
     inline static const std::string INT64 = "INT64";
 
+    /** @brief `UINT64` */
     inline static const std::string UINT64 = "UINT64";
   };
 

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/EnumValue.h b/Cesium3DTiles/generated/include/Cesium3DTiles/EnumValue.h
@@ -15,6 +15,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API EnumValue final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "EnumValue";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Extension3dTilesBoundingVolumeS2.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Extension3dTilesBoundingVolumeS2.h
@@ -13,7 +13,12 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API Extension3dTilesBoundingVolumeS2 final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Extension3dTilesBoundingVolumeS2";
+  /** @brief The official name of the extension. This should be the same as its
+   * key in the `extensions` object. */
   static constexpr const char* ExtensionName = "3DTILES_bounding_volume_S2";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/GroupMetadata.h b/Cesium3DTiles/generated/include/Cesium3DTiles/GroupMetadata.h
@@ -10,6 +10,9 @@ namespace Cesium3DTiles {
  * @brief An object containing metadata about a group.
  */
 struct CESIUM3DTILES_API GroupMetadata final : public MetadataEntity {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "GroupMetadata";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/ImplicitTiling.h b/Cesium3DTiles/generated/include/Cesium3DTiles/ImplicitTiling.h
@@ -17,15 +17,20 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API ImplicitTiling final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "ImplicitTiling";
 
   /**
    * @brief Known values for A string describing the subdivision scheme used
    * within the tileset.
    */
   struct SubdivisionScheme {
+    /** @brief `QUADTREE` */
     inline static const std::string QUADTREE = "QUADTREE";
 
+    /** @brief `OCTREE` */
     inline static const std::string OCTREE = "OCTREE";
   };
 

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/MetadataEntity.h b/Cesium3DTiles/generated/include/Cesium3DTiles/MetadataEntity.h
@@ -16,6 +16,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API MetadataEntity
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "MetadataEntity";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Properties.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Properties.h
@@ -11,6 +11,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API Properties final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Properties";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/PropertyStatistics.h b/Cesium3DTiles/generated/include/Cesium3DTiles/PropertyStatistics.h
@@ -16,6 +16,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API PropertyStatistics final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "PropertyStatistics";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/PropertyTable.h b/Cesium3DTiles/generated/include/Cesium3DTiles/PropertyTable.h
@@ -18,6 +18,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API PropertyTable final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "PropertyTable";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/PropertyTableProperty.h b/Cesium3DTiles/generated/include/Cesium3DTiles/PropertyTableProperty.h
@@ -18,31 +18,42 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API PropertyTableProperty final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "PropertyTableProperty";
 
   /**
    * @brief Known values for The type of values in `arrayOffsets`.
    */
   struct ArrayOffsetType {
+    /** @brief `UINT8` */
     inline static const std::string UINT8 = "UINT8";
 
+    /** @brief `UINT16` */
     inline static const std::string UINT16 = "UINT16";
 
+    /** @brief `UINT32` */
     inline static const std::string UINT32 = "UINT32";
 
+    /** @brief `UINT64` */
     inline static const std::string UINT64 = "UINT64";
   };
 
   /**
    * @brief Known values for The type of values in `stringOffsets`.
    */
   struct StringOffsetType {
+    /** @brief `UINT8` */
     inline static const std::string UINT8 = "UINT8";
 
+    /** @brief `UINT16` */
     inline static const std::string UINT16 = "UINT16";
 
+    /** @brief `UINT32` */
     inline static const std::string UINT32 = "UINT32";
 
+    /** @brief `UINT64` */
     inline static const std::string UINT64 = "UINT64";
   };
 

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Schema.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Schema.h
@@ -16,6 +16,9 @@ namespace Cesium3DTiles {
  * @brief An object defining classes and enums.
  */
 struct CESIUM3DTILES_API Schema final : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Schema";
 
   /**

diff --git a/Cesium3DTiles/generated/include/Cesium3DTiles/Statistics.h b/Cesium3DTiles/generated/include/Cesium3DTiles/Statistics.h
@@ -15,6 +15,9 @@ namespace Cesium3DTiles {
  */
 struct CESIUM3DTILES_API Statistics final
     : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
   static constexpr const char* TypeName = "Statistics";
 
   /**