Browse Source

CMakePackageConfigHelpers: Fix generate_apple_platform_selection_file docs

Previously the documentation was not rendered correctly.
Brad King 1 year ago
parent
commit
1a6303aa8c
1 changed files with 45 additions and 43 deletions
  1. 45 43
      Modules/CMakePackageConfigHelpers.cmake

+ 45 - 43
Modules/CMakePackageConfigHelpers.cmake

@@ -193,64 +193,66 @@ point to create more sophisticated custom ``ConfigVersion.cmake`` files.
 Generating an Apple Platform Selection File
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. versionadded:: 3.29
-
 .. command:: generate_apple_platform_selection_file
 
- Create an Apple platform selection file:
+  .. versionadded:: 3.29
 
-   generate_apple_platform_selection_file(<filename>
-     INSTALL_DESTINATION <path>
-     [MACOS_CONFIG_FILE <file>]
-     [IOS_CONFIG_FILE <file>]
-     [IOS_SIMULATOR_CONFIG_FILE <file>]
-     [TVOS_CONFIG_FILE <file>]
-     [TVOS_SIMULATOR_CONFIG_FILE <file>]
-     [WATCHOS_CONFIG_FILE <file>]
-     [WATCHOS_SIMULATOR_CONFIG_FILE <file>]
-     [VISIONOS_CONFIG_FILE <file>]
-     [VISIONOS_SIMULATOR_CONFIG_FILE <file>]
-     )
+  Create an Apple platform selection file:
+
+  .. code-block:: cmake
+
+    generate_apple_platform_selection_file(<filename>
+      INSTALL_DESTINATION <path>
+      [MACOS_CONFIG_FILE <file>]
+      [IOS_CONFIG_FILE <file>]
+      [IOS_SIMULATOR_CONFIG_FILE <file>]
+      [TVOS_CONFIG_FILE <file>]
+      [TVOS_SIMULATOR_CONFIG_FILE <file>]
+      [WATCHOS_CONFIG_FILE <file>]
+      [WATCHOS_SIMULATOR_CONFIG_FILE <file>]
+      [VISIONOS_CONFIG_FILE <file>]
+      [VISIONOS_SIMULATOR_CONFIG_FILE <file>]
+      )
 
-Writes a file for use as ``<PackageName>Config.cmake`` which can include an
-Apple-platform-specific ``<PackageName>Config.cmake`` from a different
-directory. This can be used in conjunction with the ``XCFRAMEWORK_LOCATION``
-argument of :command:`export(SETUP)` to export packages in a way that a project
-built for any Apple platform can use them.
+  Writes a file for use as ``<PackageName>Config.cmake`` which can include an
+  Apple-platform-specific ``<PackageName>Config.cmake`` from a different
+  directory. This can be used in conjunction with the ``XCFRAMEWORK_LOCATION``
+  argument of :command:`export(SETUP)` to export packages in a way that a project
+  built for any Apple platform can use them.
 
-``INSTALL_DESTINATION <path>``
-  Path that the file will be installed to.
+  ``INSTALL_DESTINATION <path>``
+    Path that the file will be installed to.
 
-``MACOS_CONFIG_FILE <file>``
-  File to include if the platform is macOS.
+  ``MACOS_CONFIG_FILE <file>``
+    File to include if the platform is macOS.
 
-``IOS_CONFIG_FILE <file>``
-  File to include if the platform is iOS.
+  ``IOS_CONFIG_FILE <file>``
+    File to include if the platform is iOS.
 
-``IOS_SIMULATOR_CONFIG_FILE <file>``
-  File to include if the platform is iOS Simulator.
+  ``IOS_SIMULATOR_CONFIG_FILE <file>``
+    File to include if the platform is iOS Simulator.
 
-``TVOS_CONFIG_FILE <file>``
-  File to include if the platform is tvOS.
+  ``TVOS_CONFIG_FILE <file>``
+    File to include if the platform is tvOS.
 
-``TVOS_SIMULATOR_CONFIG_FILE <file>``
-  File to include if the platform is tvOS Simulator.
+  ``TVOS_SIMULATOR_CONFIG_FILE <file>``
+    File to include if the platform is tvOS Simulator.
 
-``WATCHOS_CONFIG_FILE <file>``
-  File to include if the platform is watchOS.
+  ``WATCHOS_CONFIG_FILE <file>``
+    File to include if the platform is watchOS.
 
-``WATCHOS_SIMULATOR_CONFIG_FILE <file>``
-  File to include if the platform is watchOS Simulator.
+  ``WATCHOS_SIMULATOR_CONFIG_FILE <file>``
+    File to include if the platform is watchOS Simulator.
 
-``VISIONOS_CONFIG_FILE <file>``
-  File to include if the platform is visionOS.
+  ``VISIONOS_CONFIG_FILE <file>``
+    File to include if the platform is visionOS.
 
-``VISIONOS_SIMULATOR_CONFIG_FILE <file>``
-  File to include if the platform is visionOS Simulator.
+  ``VISIONOS_SIMULATOR_CONFIG_FILE <file>``
+    File to include if the platform is visionOS Simulator.
 
-If any of the optional config files are not specified, and the consuming
-project is built for their corresponding platform, an error will be thrown
-when including the generated file.
+  If any of the optional config files are not specified, and the consuming
+  project is built for their corresponding platform, an error will be thrown
+  when including the generated file.
 
 Example Generating Package Files
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^