Merge pull request #1429 from CesiumGS/copilot/use-doxygen-ref-syntax

Replace JSDoc `{@link}` with Doxygen `@ref` throughout codebase

Author: j9liu

.clang-format

@@ -32,8 +32,8 @@ PointerAlignment: Left
 ConstructorInitializerAllOnOneLineOrOnePerLine: true
 
 # Do not break comment lines that contain the given regex. This
-# is here to avoid breaking lines within "{@link SomeClass}"
-# which would cause doxygen to fail.
+# is here to avoid breaking lines within braced expressions in
+# Doxygen comments, which would cause doxygen to fail.
 CommentPragmas: '{.*}'
 
 # Disregard any exising include order, and re-order the headers

Cesium3DTiles/generated/include/Cesium3DTiles/Availability.h

@@ -49,7 +49,7 @@ struct CESIUM3DTILES_API Availability final
    * @brief Integer indicating whether all of the elements are available (1) or
    * all are unavailable (0).
    *
-   * Known values are defined in {@link Constant}.
+   * Known values are defined in @ref Constant.
    *
    */
   std::optional<int32_t> constant;

Cesium3DTiles/generated/include/Cesium3DTiles/BufferSpec.h

@@ -61,7 +61,8 @@ struct CESIUM3DTILES_API BufferSpec : public CesiumUtility::ExtensibleObject {
 
 protected:
   /**
-   * @brief This class is not meant to be instantiated directly. Use {@link Buffer} instead.
+   * @brief This class is not meant to be instantiated directly. Use @ref Buffer
+   * instead.
    */
   BufferSpec() = default;
   friend struct Buffer;

Cesium3DTiles/generated/include/Cesium3DTiles/ClassProperty.h

@@ -105,7 +105,7 @@ struct CESIUM3DTILES_API ClassProperty final
   /**
    * @brief The element type.
    *
-   * Known values are defined in {@link Type}.
+   * Known values are defined in @ref Type.
    *
    */
   std::string type = Type::SCALAR;
@@ -114,7 +114,7 @@ struct CESIUM3DTILES_API ClassProperty final
    * @brief The datatype of the element's components. Required for `SCALAR`,
    * `VECN`, and `MATN` types, and disallowed for other types.
    *
-   * Known values are defined in {@link ComponentType}.
+   * Known values are defined in @ref ComponentType.
    *
    */
   std::optional<std::string> componentType;

Cesium3DTiles/generated/include/Cesium3DTiles/Enum.h

@@ -62,7 +62,7 @@ struct CESIUM3DTILES_API Enum final : public CesiumUtility::ExtensibleObject {
   /**
    * @brief The type of the integer enum value.
    *
-   * Known values are defined in {@link ValueType}.
+   * Known values are defined in @ref ValueType.
    *
    */
   std::string valueType = ValueType::UINT16;

Cesium3DTiles/generated/include/Cesium3DTiles/ExtensionSchemaMaxarContentGeoJsonGeometryValue.h

@@ -46,7 +46,7 @@ struct CESIUM3DTILES_API ExtensionSchemaMaxarContentGeoJsonGeometryValue final
   /**
    * @brief Type of GeoJSON geometry inside the group
    *
-   * Known values are defined in {@link Type}.
+   * Known values are defined in @ref Type.
    *
    */
   std::string type = Type::Point;

Cesium3DTiles/generated/include/Cesium3DTiles/ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h

@@ -52,7 +52,7 @@ struct CESIUM3DTILES_API ExtensionSchemaMaxarContentGeoJsonPropertiesValue final
    * @brief Expected datatype of the property value in the GeoJSON Feature's
    * 'properties' object
    *
-   * Known values are defined in {@link Type}.
+   * Known values are defined in @ref Type.
    *
    */
   std::string type = Type::Integer;

Cesium3DTiles/generated/include/Cesium3DTiles/ImplicitTiling.h

@@ -37,7 +37,7 @@ struct CESIUM3DTILES_API ImplicitTiling final
   /**
    * @brief A string describing the subdivision scheme used within the tileset.
    *
-   * Known values are defined in {@link SubdivisionScheme}.
+   * Known values are defined in @ref SubdivisionScheme.
    *
    */
   std::string subdivisionScheme = SubdivisionScheme::QUADTREE;

Cesium3DTiles/generated/include/Cesium3DTiles/PropertyTableProperty.h

@@ -103,15 +103,15 @@ struct CESIUM3DTILES_API PropertyTableProperty final
   /**
    * @brief The type of values in `arrayOffsets`.
    *
-   * Known values are defined in {@link ArrayOffsetType}.
+   * Known values are defined in @ref ArrayOffsetType.
    *
    */
   std::string arrayOffsetType = ArrayOffsetType::UINT32;
 
   /**
    * @brief The type of values in `stringOffsets`.
    *
-   * Known values are defined in {@link StringOffsetType}.
+   * Known values are defined in @ref StringOffsetType.
    *
    */
   std::string stringOffsetType = StringOffsetType::UINT32;

Cesium3DTiles/generated/include/Cesium3DTiles/Tile.h

@@ -62,7 +62,7 @@ struct CESIUM3DTILES_API Tile final : public CesiumUtility::ExtensibleObject {
    * root tile of a tileset; it is optional for all other tiles. The default is
    * to inherit from the parent tile.
    *
-   * Known values are defined in {@link Refine}.
+   * Known values are defined in @ref Refine.
    *
    */
   std::optional<std::string> refine;