Formatting and typo fix

Author: j9liu

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 @ref 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/TilesetSpec.h

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

Cesium3DTiles/include/Cesium3DTiles/MetadataQuery.h

@@ -13,7 +13,7 @@ namespace Cesium3DTiles {
  * @brief Holds the details of a found property in a @ref MetadataEntity.
  *
  * Because this structure holds _references_ to the original @ref Schema and
- * @ref MetadataEntity instances, it will be invalided if either are
+ * @ref MetadataEntity instances, it will be invalidated if either are
  * destroyed or modified. Continuing to access this result in that scenario will
  * result in undefined behavior.
  */

Cesium3DTilesContent/include/Cesium3DTilesContent/GltfConverters.h

@@ -165,7 +165,8 @@ class CESIUM3DTILESCONTENT_API GltfConverters {
    * returned
    *
    * @param filePath The file path that contains the file extension.
-   * @return The @ref ConverterFunction that is registered with the file extension.
+   * @return The @ref ConverterFunction that is registered with the file
+   * extension.
    */
   static ConverterFunction
   getConverterByFileExtension(const std::string& filePath);
@@ -180,7 +181,8 @@ class CESIUM3DTILESCONTENT_API GltfConverters {
    * @ref GltfConverterResult from the input data.
    *
    * @param content The binary tile content that contains the magic header.
-   * @return The @ref ConverterFunction that is registered with the magic header.
+   * @return The @ref ConverterFunction that is registered with the magic
+   * header.
    */
   static ConverterFunction
   getConverterByMagic(const std::span<const std::byte>& content);
@@ -211,7 +213,8 @@ class CESIUM3DTILESCONTENT_API GltfConverters {
    * @param options The @ref CesiumGltfReader::GltfReaderOptions for how to
    * read a glTF.
    * @param assetFetcher An object that can perform recursive asset requests.
-   * @return The @ref GltfConverterResult that stores the gltf model converted from the binary data.
+   * @return The @ref GltfConverterResult that stores the gltf model converted
+   * from the binary data.
    */
   static CesiumAsync::Future<GltfConverterResult> convert(
       const std::string& filePath,
@@ -239,7 +242,8 @@ class CESIUM3DTILESCONTENT_API GltfConverters {
    * @param options The @ref CesiumGltfReader::GltfReaderOptions for how to
    * read a glTF.
    * @param assetFetcher An object that can perform recursive asset requests.
-   * @return The @ref GltfConverterResult that stores the gltf model converted from the binary data.
+   * @return The @ref GltfConverterResult that stores the gltf model converted
+   * from the binary data.
    */
   static CesiumAsync::Future<GltfConverterResult> convert(
       const std::span<const std::byte>& content,

Cesium3DTilesSelection/include/Cesium3DTilesSelection/BoundingVolume.h

@@ -75,7 +75,8 @@ estimateGlobeRectangle(
 
 /**
  * @brief Returns the bounding region if the bounding volume is a
- * @ref CesiumGeospatial::BoundingRegion or a @ref CesiumGeospatial::BoundingRegionWithLooseFittingHeights.
+ * @ref CesiumGeospatial::BoundingRegion or a @ref
+ * CesiumGeospatial::BoundingRegionWithLooseFittingHeights.
  *
  * @param boundingVolume The bounding volume.
  * @return A pointer to the bounding region, or nullptr is the bounding volume
@@ -85,7 +86,8 @@ CESIUM3DTILESSELECTION_API const CesiumGeospatial::BoundingRegion*
 getBoundingRegionFromBoundingVolume(const BoundingVolume& boundingVolume);
 
 /**
- * @brief Returns an oriented bounding box that contains the given @ref BoundingVolume.
+ * @brief Returns an oriented bounding box that contains the given @ref
+ * BoundingVolume.
  *
  * @param boundingVolume The bounding volume.
  * @param ellipsoid The ellipsoid used for this @ref BoundingVolume.

Cesium3DTilesSelection/include/Cesium3DTilesSelection/ITileExcluder.h

@@ -13,7 +13,8 @@ class ITileExcluder {
   virtual ~ITileExcluder() = default;
 
   /**
-   * @brief Indicates the start of a new frame, initiated with a call to @ref Tileset::updateView.
+   * @brief Indicates the start of a new frame, initiated with a call to @ref
+   * Tileset::updateView.
    */
   virtual void startNewFrame() noexcept {}
 

Cesium3DTilesSelection/include/Cesium3DTilesSelection/RasterMappedTo3DTile.h

@@ -17,11 +17,12 @@ namespace Cesium3DTilesSelection {
 class Tile;
 
 /**
- * @brief The result of applying a @ref CesiumRasterOverlays::RasterOverlayTile to geometry.
+ * @brief The result of applying a @ref CesiumRasterOverlays::RasterOverlayTile
+ * to geometry.
  *
  * Instances of this class are used by a @ref Tile in order to map
- * imagery data that is given as @ref CesiumRasterOverlays::RasterOverlayTile instances
- * to the 2D region that is covered by the tile geometry.
+ * imagery data that is given as @ref CesiumRasterOverlays::RasterOverlayTile
+ * instances to the 2D region that is covered by the tile geometry.
  */
 class RasterMappedTo3DTile final {
 public:
@@ -50,8 +51,8 @@ class RasterMappedTo3DTile final {
   /**
    * @brief Creates a new instance.
    *
-   * @param pRasterTile The @ref CesiumRasterOverlays::RasterOverlayTile that is mapped to the
-   * geometry.
+   * @param pRasterTile The @ref CesiumRasterOverlays::RasterOverlayTile that is
+   * mapped to the geometry.
    * @param textureCoordinateIndex The index of the texture coordinates to use
    * with this mapped raster overlay.
    */
@@ -61,7 +62,8 @@ class RasterMappedTo3DTile final {
       int32_t textureCoordinateIndex);
 
   /**
-   * @brief Returns a @ref CesiumRasterOverlays::RasterOverlayTile that is currently loading.
+   * @brief Returns a @ref CesiumRasterOverlays::RasterOverlayTile that is
+   * currently loading.
    *
    * The caller has to check the exact state of this tile, using
    * @ref Tile::getState.
@@ -79,8 +81,8 @@ class RasterMappedTo3DTile final {
   }
 
   /**
-   * @brief Returns the @ref CesiumRasterOverlays::RasterOverlayTile that represents the imagery
-   * data that is ready to render.
+   * @brief Returns the @ref CesiumRasterOverlays::RasterOverlayTile that
+   * represents the imagery data that is ready to render.
    *
    * This will be `nullptr` when the tile data has not yet been loaded.
    *
@@ -163,7 +165,8 @@ class RasterMappedTo3DTile final {
    * @param prepareRendererResources The @ref IPrepareRendererResources used to
    * create render resources for raster overlay
    * @param tile The owner tile.
-   * @return The @ref CesiumRasterOverlays::RasterOverlayTile::MoreDetailAvailable state.
+   * @return The @ref
+   * CesiumRasterOverlays::RasterOverlayTile::MoreDetailAvailable state.
    */
   CesiumRasterOverlays::RasterOverlayTile::MoreDetailAvailable
   update(IPrepareRendererResources& prepareRendererResources, Tile& tile);
@@ -184,7 +187,8 @@ class RasterMappedTo3DTile final {
       Tile& tile) noexcept;
 
   /**
-   * @brief Does a throttled load of the mapped @ref CesiumRasterOverlays::RasterOverlayTile.
+   * @brief Does a throttled load of the mapped @ref
+   * CesiumRasterOverlays::RasterOverlayTile.
    *
    * @return If the mapped tile is already in the process of loading or it has
    * already finished loading, this method does nothing and returns true. If too
@@ -195,13 +199,14 @@ class RasterMappedTo3DTile final {
   bool loadThrottled() noexcept;
 
   /**
-   * @brief Creates a maping between a @ref CesiumRasterOverlays::RasterOverlay and a @ref Tile.
-   *
-   * The returned mapping will be to a placeholder @ref CesiumRasterOverlays::RasterOverlayTile if
-   * the overlay's tile provider is not yet ready (i.e. it's still a
-   * placeholder) or if the overlap between the tile and the raster overlay
-   * cannot yet be determined because the projected rectangle of the tile is not
-   * yet known.
+   * @brief Creates a maping between a @ref CesiumRasterOverlays::RasterOverlay
+   * and a @ref Tile.
+   *
+   * The returned mapping will be to a placeholder @ref
+   * CesiumRasterOverlays::RasterOverlayTile if the overlay's tile provider is
+   * not yet ready (i.e. it's still a placeholder) or if the overlap between the
+   * tile and the raster overlay cannot yet be determined because the projected
+   * rectangle of the tile is not yet known.
    *
    * Returns a pointer to the created `RasterMappedTo3DTile` in the Tile's
    * @ref Tile::getMappedRasterTiles collection. Note that this pointer may

Cesium3DTilesSelection/include/Cesium3DTilesSelection/RasterOverlayCollection.h

@@ -56,15 +56,16 @@ struct TileRasterOverlayStatus {
 };
 
 /**
- * @brief A collection of @ref CesiumRasterOverlays::RasterOverlay instances that are associated
- * with a @ref Tileset.
+ * @brief A collection of @ref CesiumRasterOverlays::RasterOverlay instances
+ * that are associated with a @ref Tileset.
  *
  * The raster overlay instances may be added to the raster overlay collection
  * of a tileset that is returned with @ref Tileset::getOverlays. When the
- * tileset is loaded, one @ref CesiumRasterOverlays::RasterOverlayTileProvider will be created
- * for each raster overlay that had been added. The raster overlay tile provider
- * instances will be passed to the @ref CesiumRasterOverlays::RasterOverlayTile instances that
- * they create when the tiles are updated.
+ * tileset is loaded, one @ref CesiumRasterOverlays::RasterOverlayTileProvider
+ * will be created for each raster overlay that had been added. The raster
+ * overlay tile provider instances will be passed to the @ref
+ * CesiumRasterOverlays::RasterOverlayTile instances that they create when the
+ * tiles are updated.
  */
 class CESIUM3DTILESSELECTION_API RasterOverlayCollection final {
 public:
@@ -139,7 +140,8 @@ class CESIUM3DTILESSELECTION_API RasterOverlayCollection final {
   getActivatedOverlays() const noexcept;
 
   /**
-   * @brief Adds the given @ref CesiumRasterOverlays::RasterOverlay to this collection.
+   * @brief Adds the given @ref CesiumRasterOverlays::RasterOverlay to this
+   * collection.
    *
    * @param pOverlay The pointer to the overlay. This may not be `nullptr`.
    */
@@ -207,7 +209,8 @@ class CESIUM3DTILESSELECTION_API RasterOverlayCollection final {
 
 public:
   /**
-   * @brief A constant iterator for @ref CesiumRasterOverlays::RasterOverlay instances.
+   * @brief A constant iterator for @ref CesiumRasterOverlays::RasterOverlay
+   * instances.
    */
   using const_iterator = CesiumUtility::TransformIterator<
       GetOverlayFunctor,

Cesium3DTilesSelection/include/Cesium3DTilesSelection/RasterizedPolygonsTileExcluder.h

@@ -12,9 +12,9 @@ namespace Cesium3DTilesSelection {
 
 /**
  * @brief When provided to @ref TilesetOptions::excluders, uses the polygons
- * owned by a @ref CesiumRasterOverlays::RasterizedPolygonsOverlay to exclude tiles that are
- * entirely inside any of the polygon from loading. This is useful when the
- * polygons will be used for clipping.
+ * owned by a @ref CesiumRasterOverlays::RasterizedPolygonsOverlay to exclude
+ * tiles that are entirely inside any of the polygon from loading. This is
+ * useful when the polygons will be used for clipping.
  */
 class CESIUM3DTILESSELECTION_API RasterizedPolygonsTileExcluder
     : public Cesium3DTilesSelection::ITileExcluder {

Cesium3DTilesSelection/include/Cesium3DTilesSelection/Tile.h

@@ -165,7 +165,8 @@ class CESIUM3DTILESSELECTION_API Tile final {
    * ID is changed in order to avoid reference count assertion failures at
    * tileset destruction.
    *
-   * @param pLoader The @ref TilesetContentLoader that is assiocated with this tile.
+   * @param pLoader The @ref TilesetContentLoader that is assiocated with this
+   * tile.
    * @param tileID The ID of this tile. If it is an empty string, then the
    * external content will not be unloadable.
    * @param externalContent External content that is associated with this tile.
@@ -187,7 +188,8 @@ class CESIUM3DTILESSELECTION_API Tile final {
    * ID is changed in order to avoid reference count assertion failures at
    * tileset destruction.
    *
-   * @param pLoader The @ref TilesetContentLoader that is assiocated with this tile.
+   * @param pLoader The @ref TilesetContentLoader that is assiocated with this
+   * tile.
    * @param tileID The ID of this tile. If it is an empty string, then the
    * empty content will not be unloadable.
    * @param emptyContent A content tag indicating that the tile has no content.
@@ -353,14 +355,15 @@ class CESIUM3DTILESSELECTION_API Tile final {
   /**
    * @brief Gets the tile's geometric error as if by calling
    * @ref getGeometricError, except that if the error is smaller than
-   * @ref CesiumUtility::Math::Epsilon5 the returned geometric error is instead computed as
-   * half of the parent tile's (non-zero) geometric error.
+   * @ref CesiumUtility::Math::Epsilon5 the returned geometric error is instead
+   * computed as half of the parent tile's (non-zero) geometric error.
    *
    * This is useful for determining when to refine what would ordinarily be a
    * leaf tile, for example to attach more detailed raster overlays to it.
    *
    * If this tile and all of its ancestors have a geometric error less than
-   * @ref CesiumUtility::Math::Epsilon5, returns @ref CesiumUtility::Math::Epsilon5.
+   * @ref CesiumUtility::Math::Epsilon5, returns @ref
+   * CesiumUtility::Math::Epsilon5.
    *
    * @return The non-zero geometric error.
    */