Shuffle around doxygen snippet and remove CMAKE_EXPORT_COMPILE_COMMANDS

KhronosGroup · Dec 2, 2023 · c4cc963 · c4cc963
1 parent 4263d61
commit c4cc963
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 27 deletions.
diff --git a/ci_scripts/build_macos.sh b/ci_scripts/build_macos.sh
@@ -78,7 +78,6 @@ cmake_args=("-G" "Xcode" \
   "-D" "KTX_FEATURE_TOOLS_CTS=$FEATURE_TOOLS_CTS" \
   "-D" "KTX_LOADTEST_APPS_USE_LOCAL_DEPENDENCIES=$LOADTESTS_USE_LOCAL_DEPENDENCIES" \
   "-D" "KTX_WERROR=$WERROR" \
-  "-D" "CMAKE_EXPORT_COMPILE_COMMANDS=ON" \
   "-D" "BASISU_SUPPORT_OPENCL=$SUPPORT_OPENCL" \
   "-D" "BASISU_SUPPORT_SSE=$SUPPORT_SSE" \
 )

diff --git a/tools/ktx/astc_utils.h b/tools/ktx/astc_utils.h
@@ -8,6 +8,34 @@
 
 namespace ktx {
 
+/**
+//! [command options_astc]
+<dl>
+    <dt>\--astc-quality &lt;level&gt;</dt>
+    <dd>The quality level configures the quality-performance
+        tradeoff for the compressor; more complete searches of the
+        search space improve image quality at the expense of
+        compression time. Default is 'medium'. The quality level can be
+        set between fastest (0) and exhaustive (100) via the
+        following fixed quality presets:
+        <table>
+            <tr><th>Level      </th> <th> Quality                      </th></tr>
+            <tr><td>fastest    </td> <td>(equivalent to quality =   0) </td></tr>
+            <tr><td>fast       </td> <td>(equivalent to quality =  10) </td></tr>
+            <tr><td>medium     </td> <td>(equivalent to quality =  60) </td></tr>
+            <tr><td>thorough   </td> <td>(equivalent to quality =  98) </td></tr>
+            <tr><td>exhaustive </td> <td>(equivalent to quality = 100) </td></tr>
+        </table>
+    </dd>
+    <dt>\--astc-perceptual</dt>
+    <dd>The codec should optimize for perceptual error, instead of
+        direct RMS error. This aims to improve perceived image quality,
+        but typically lowers the measured PSNR score. Perceptual
+        methods are currently only available for normal maps and RGB
+        color data.</dd>
+</dl>
+//! [command options_astc]
+*/
 struct OptionsASTC : public ktxAstcParams {
     inline static const char* kAstcQuality = "astc-quality";
     inline static const char* kAstcPerceptual = "astc-perceptual";

diff --git a/tools/ktx/command_create.cpp b/tools/ktx/command_create.cpp
@@ -601,30 +601,7 @@ Create a KTX2 file from various input files.
             otherwise they are ignored.<br />
             The format will be used to verify and load all input files into a texture before encoding.<br />
             Case insensitive. Required.</dd>
-        <dl>
-            <dt>\--astc-quality &lt;level&gt;</dt>
-            <dd>The quality level configures the quality-performance
-                tradeoff for the compressor; more complete searches of the
-                search space improve image quality at the expense of
-                compression time. Default is 'medium'. The quality level can be
-                set between fastest (0) and exhaustive (100) via the
-                following fixed quality presets:
-                <table>
-                    <tr><th>Level      </th> <th> Quality                      </th></tr>
-                    <tr><td>fastest    </td> <td>(equivalent to quality =   0) </td></tr>
-                    <tr><td>fast       </td> <td>(equivalent to quality =  10) </td></tr>
-                    <tr><td>medium     </td> <td>(equivalent to quality =  60) </td></tr>
-                    <tr><td>thorough   </td> <td>(equivalent to quality =  98) </td></tr>
-                    <tr><td>exhaustive </td> <td>(equivalent to quality = 100) </td></tr>
-                </table>
-            </dd>
-            <dt>\--astc-perceptual</dt>
-            <dd>The codec should optimize for perceptual error, instead of
-                direct RMS error. This aims to improve perceived image quality,
-                but typically lowers the measured PSNR score. Perceptual
-                methods are currently only available for normal maps and RGB
-                color data.</dd>
-        </dl>
+			@snippet{doc} ktx/astc_utils.h command options_astc
         <dt>\--1d</dt>
         <dd>Create a 1D texture. If not set the texture will be a 2D or 3D texture.</dd>
         <dt>\--cubemap</dt>

diff --git a/tools/ktx/command_encode_astc.cpp b/tools/ktx/command_encode_astc.cpp
@@ -23,7 +23,6 @@
 #include <fmt/ostream.h>
 #include <fmt/printf.h>
 
-
 namespace ktx {
 
 /** @page ktx_encode_astc ktx encode_astc
@@ -45,7 +44,7 @@ Encode a KTX2 file.
 
     The following options are available:
     <dl>
-        @snippet{doc} ktx/encode_utils.h command options_codec
+        @snippet{doc} ktx/astc_utils.h command options_astc
         @snippet{doc} ktx/metrics_utils.h command options_metrics
     </dl>
     @snippet{doc} ktx/compress_utils.h command options_compress