Browse Source

FindVulkan: Format component documentation as definition list

Brad King 3 years ago
parent
commit
db66c384fc
1 changed files with 20 additions and 4 deletions
  1. 20 4
      Modules/FindVulkan.cmake

+ 20 - 4
Modules/FindVulkan.cmake

@@ -15,10 +15,26 @@ Optional COMPONENTS
 
 .. versionadded:: 3.24
 
-This module respects several optional COMPONENTS: ``glslc``,
-``glslangValidator``, ``glslang``, ``shaderc_combined`` and ``SPIRV-Tools``.
-On macOS, an additional component ``MoltenVK`` is available.
-There are corresponding import targets for each of these flags.
+This module respects several optional COMPONENTS.
+There are corresponding imported targets for each of these.
+
+``glslc``
+  The SPIR-V compiler.
+
+``glslangValidator``
+  The ``glslangValidator`` tool.
+
+``glslang``
+  The SPIR-V generator library.
+
+``shaderc_combined``
+  The static library for Vulkan shader compilation.
+
+``SPIRV-Tools``
+  Tools to process SPIR-V modules.
+
+``MoltenVK``
+  On macOS, an additional component ``MoltenVK`` is available.
 
 IMPORTED Targets
 ^^^^^^^^^^^^^^^^