Skip to content
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.

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

Fix all Doxygen warnings #1040

Merged
merged 14 commits into from
Dec 18, 2024
  •  
  •  
  •  
6 changes: 5 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

### ? - ?

##### Breaking Changes :mega:

- Removed unused types `JsonValueMissingKey` and `JsonValueNotRealValue` from `CesiumUtility`.

##### Additions :tada:

- Added `offset` getter to `AccessorView`.
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 hello@cesium.com!

Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/Asset.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
5 changes: 5 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/Availability.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/BufferSpec.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/BufferView.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/Class.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
23 changes: 23 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/ClassProperty.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";
};

Expand All @@ -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";
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/Content.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
11 changes: 11 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/Enum.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";
};

Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/EnumValue.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/GroupMetadata.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/Properties.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/PropertyTable.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";
};

Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/Schema.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
3 changes: 3 additions & 0 deletions Cesium3DTiles/generated/include/Cesium3DTiles/Statistics.h
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
Loading