Doc and cleanup.

CesiumGS · Oct 30, 2024 · e8fbd40 · e8fbd40
1 parent 9dfe894
commit e8fbd40
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 9 deletions.
diff --git a/CesiumGltfReader/include/CesiumGltfReader/ImageDecoder.h b/CesiumGltfReader/include/CesiumGltfReader/ImageDecoder.h
@@ -14,8 +14,7 @@
 namespace CesiumGltfReader {
 
 /**
- * @brief The result of reading an image with
- * {@link ImageDecoder::readImage}.
+ * @brief The result of reading an image with {@link ImageDecoder::readImage}.
  */
 struct CESIUMGLTFREADER_API ImageReaderResult {
 
@@ -37,6 +36,9 @@ struct CESIUMGLTFREADER_API ImageReaderResult {
   std::vector<std::string> warnings;
 };
 
+/**
+ * @brief Contains methods for reading and manipulating images.
+ */
 class ImageDecoder {
 public:
   /**

diff --git a/CesiumGltfReader/include/CesiumGltfReader/NetworkImageAssetDescriptor.h b/CesiumGltfReader/include/CesiumGltfReader/NetworkImageAssetDescriptor.h
@@ -42,8 +42,7 @@ struct NetworkImageAssetDescriptor
    * @return A future that resolves to the image asset once the request is
    * complete.
    */
-  CesiumAsync::Future<CesiumUtility::Result<
-      CesiumUtility::IntrusivePointer<CesiumGltf::ImageAsset>>>
+  CesiumAsync::Future<CesiumUtility::ResultPointer<CesiumGltf::ImageAsset>>
   load(
       const CesiumAsync::AsyncSystem& asyncSystem,
       const std::shared_ptr<CesiumAsync::IAssetAccessor>& pAssetAccessor) const;

diff --git a/CesiumGltfReader/src/GltfReader.cpp b/CesiumGltfReader/src/GltfReader.cpp
@@ -8,13 +8,10 @@
 #include "dequantizeMeshData.h"
 #include "registerReaderExtensions.h"
 
-#include <CesiumAsync/IAssetAccessor.h>
 #include <CesiumAsync/IAssetRequest.h>
 #include <CesiumAsync/IAssetResponse.h>
 #include <CesiumGltf/ExtensionKhrTextureBasisu.h>
 #include <CesiumGltf/ExtensionTextureWebp.h>
-#include <CesiumGltf/ImageAsset.h>
-#include <CesiumGltf/Ktx2TranscodeTargets.h>
 #include <CesiumJsonReader/JsonHandler.h>
 #include <CesiumJsonReader/JsonReader.h>
 #include <CesiumJsonReader/JsonReaderOptions.h>
@@ -29,7 +26,6 @@
 #include <algorithm>
 #include <cstddef>
 #include <iomanip>
-#include <memory>
 #include <sstream>
 #include <string>
 

diff --git a/CesiumJsonReader/include/CesiumJsonReader/IgnoreValueJsonHandler.h b/CesiumJsonReader/include/CesiumJsonReader/IgnoreValueJsonHandler.h
@@ -4,7 +4,6 @@
 #include "Library.h"
 
 #include <cstdint>
-#include <string>
 
 namespace CesiumJsonReader {
 class CESIUMJSONREADER_API IgnoreValueJsonHandler : public IJsonHandler {

diff --git a/CesiumUtility/include/CesiumUtility/Hash.h b/CesiumUtility/include/CesiumUtility/Hash.h
@@ -4,7 +4,19 @@
 
 namespace CesiumUtility {
 
+/**
+ * @brief Contains functions for working with hashes.
+ *
+ */
 struct Hash {
+  /**
+   * @brief Combines two hash values, usually generated using `std::hash`, to
+   * form a single hash value.
+   *
+   * @param first The first hash value.
+   * @param second The second hash value.
+   * @return A new hash value which is a combination of the two.
+   */
   static std::size_t combine(std::size_t first, std::size_t second);
 };