Fixing documentation

KhronosGroup · Sep 16, 2023 · 74e7118 · 74e7118
1 parent 91fb25e
commit 74e7118
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 8 deletions.
diff --git a/include/ktxvulkan.h b/include/ktxvulkan.h
@@ -134,13 +134,20 @@ typedef VkResult(*ktxVulkanTexture_subAllocatorBindImageFuncPtr)(VkImage image,
 typedef VkResult(*ktxVulkanTexture_subAllocatorMemoryMapFuncPtr)(uint64_t allocId, uint64_t pageNumber, VkDeviceSize *mapLength, void** dataPtr);
 typedef void (*ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtr)(uint64_t allocId, uint64_t pageNumber);
 typedef void (*ktxVulkanTexture_subAllocatorFreeMemFuncPtr)(uint64_t allocId);
+/**
+ * @class ktxVulkanTexture_subAllocatorCallbacks
+ * @~English
+ * @brief Struct that contains all callbacks necessary for suballocation.
+ *
+ * These pointers must all be provided for upload or destroy to occur using suballocator callbacks.
+ */
 typedef struct {
-    ktxVulkanTexture_subAllocatorAllocMemFuncPtr allocMemFuncPtr;
-    ktxVulkanTexture_subAllocatorBindBufferFuncPtr bindBufferFuncPtr;
-    ktxVulkanTexture_subAllocatorBindImageFuncPtr bindImageFuncPtr;
-    ktxVulkanTexture_subAllocatorMemoryMapFuncPtr memoryMapFuncPtr;
-    ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtr memoryUnmapFuncPtr;
-    ktxVulkanTexture_subAllocatorFreeMemFuncPtr freeMemFuncPtr;
+    ktxVulkanTexture_subAllocatorAllocMemFuncPtr allocMemFuncPtr; /*!< Pointer to the memory procurement function. Can suballocate one or more pages. */
+    ktxVulkanTexture_subAllocatorBindBufferFuncPtr bindBufferFuncPtr; /*!< Pointer to bind-buffer-to-suballocation(s) function. */
+    ktxVulkanTexture_subAllocatorBindImageFuncPtr bindImageFuncPtr; /*!< Pointer to bind-image-to-suballocation(s) function. */
+    ktxVulkanTexture_subAllocatorMemoryMapFuncPtr memoryMapFuncPtr; /*!< Pointer to function for mapping the memory of a specific page. */
+    ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtr memoryUnmapFuncPtr; /*!< Pointer to function for unmapping the memory of a specific page. */
+    ktxVulkanTexture_subAllocatorFreeMemFuncPtr freeMemFuncPtr; /*!< Pointer to free procurement function. */
 } ktxVulkanTexture_subAllocatorCallbacks;
 
 KTX_API ktx_error_code_e KTX_APIENTRY

diff --git a/lib/vkloader.c b/lib/vkloader.c
@@ -1476,7 +1476,7 @@ ktxTexture_VkUpload(ktxTexture* texture, ktxVulkanDeviceInfo* vdi,
  *
  * This simplly calls ktxTexture_VkUploadEx.
  *
- * @copydetails ktxTexture::ktxTexture_VkUploadEx
+ * @copybrief ktxTexture::ktxTexture_VkUploadEx
  */
 KTX_error_code
 ktxTexture1_VkUploadEx(ktxTexture1* This, ktxVulkanDeviceInfo* vdi,
@@ -1516,7 +1516,7 @@ ktxTexture1_VkUpload(ktxTexture1* texture, ktxVulkanDeviceInfo* vdi,
  *
  * This simplly calls ktxTexture_VkUploadEx.
  *
- * @copydetails ktxTexture::ktxTexture_VkUploadEx
+ * @copybrief ktxTexture::ktxTexture_VkUploadEx
  */
 KTX_error_code
 ktxTexture2_VkUploadEx(ktxTexture2* This, ktxVulkanDeviceInfo* vdi,