style: improve comments for readability

Signed-off-by: msclock <[email protected]>
msclock · Oct 12, 2023 · 1d7b404 · 1d7b404
1 parent 988c1db
commit 1d7b404
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 22 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -68,3 +68,4 @@ repos:
         args:
           - -L=lang
           - --check-filenames
+          - --write-changes
diff --git a/cmake/build/LinkOptimization.cmake b/cmake/build/LinkOptimization.cmake
@@ -22,13 +22,14 @@ the License.
 
 include(CheckIPOSupported)
 
-# Checks for, and enables IPO/LTO for all following targets
-#
-# Running with GCC seems to have no effect
-# ~~~
-# Optional:
-# REQUIRED - If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported
-# ~~~
+#[[
+Checks for, and enables IPO/LTO for all following targets
+
+Running with GCC seems to have no effect
+
+Optional:
+  REQUIRED - If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported
+]]
 macro(link_time_optimization)
   # Argument parsing
   set(options REQUIRED)
@@ -55,15 +56,15 @@ macro(link_time_optimization)
   endif()
 endmacro()
 
-# Checks for, and enables IPO/LTO for the specified target
-#
-# Running with GCC seems to have no effect
-# ~~~
-# Required:
-# TARGET_NAME - Name of the target to generate code coverage for
-# Optional:
-# REQUIRED - If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported
-# ~~~
+#[[
+Checks for, and enables IPO/LTO for the specified target
+
+Running with GCC seems to have no effect
+
+Arguments:
+  TARGET_NAME - Name of the target to generate code coverage for.(required)
+  REQUIRED - If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported.(optional)
+]]
 function(target_link_time_optimization TARGET_NAME)
   # Argument parsing
   set(options REQUIRED)

diff --git a/cmake/install/InstallDependency.cmake b/cmake/install/InstallDependency.cmake
@@ -9,12 +9,12 @@ A function to enable installation of dependencies as part of the
  `make install` process.
 
 Arguments:
-  TARGETS - a list of installed targets to have dependencies copied for (required)
-  DESTINATION - the runtime directory for those targets (usually `bin`)
-  DIRECTORIES - the directories to search dependencies (required)
-  PRE_EXCLUDE_REGEXES - regular expressions to handle results (optional)
-  POST_EXCLUDE_REGEXES - regular expressions to handle results (optional)
-  POST_INCLUDE_REGEXES - regular expressions to handle results (optional)
+  TARGETS - a list of installed targets to have dependencies copied for. (required)
+  DIRECTORIES - the directories to search dependencies. (required)
+  DESTINATION - the runtime directory for those targets (usually `$<IF:$<PLATFORM_ID:Windows>,bin,lib>`).(optional)
+  PRE_EXCLUDE_REGEXES - regular expressions to handle results. (optional)
+  POST_EXCLUDE_REGEXES - regular expressions to handle results. (optional)
+  POST_INCLUDE_REGEXES - regular expressions to handle results. (optional)
 
 Examples:
   set(app ${CMAKE_PROJECT_NAME}_app)