diff options
author | Alex Neundorf <neundorf@kde.org> | 2011-12-11 14:18:59 +0100 |
---|---|---|
committer | Alex Neundorf <neundorf@kde.org> | 2011-12-11 14:18:59 +0100 |
commit | 0ca58c1f26c7eb606fb734d2df34ca5dca9e09fb (patch) | |
tree | e23bdcc44b2396e76d81516b08bdcb25c5671c76 /modules | |
parent | 5908cadf3dff5e0a67cbe2c864fae0d0caca6e58 (diff) | |
download | extra-cmake-modules-0ca58c1f26c7eb606fb734d2df34ca5dca9e09fb.tar.gz extra-cmake-modules-0ca58c1f26c7eb606fb734d2df34ca5dca9e09fb.tar.bz2 |
improve documentation formatting
Alex
Diffstat (limited to 'modules')
-rw-r--r-- | modules/ECMOptionalAddSubdirectory.cmake | 3 | ||||
-rw-r--r-- | modules/ECMPrintVariables.cmake | 1 | ||||
-rw-r--r-- | modules/ECMSetVersionVariables.cmake | 1 |
3 files changed, 5 insertions, 0 deletions
diff --git a/modules/ECMOptionalAddSubdirectory.cmake b/modules/ECMOptionalAddSubdirectory.cmake index ef6592a0..c7931f0c 100644 --- a/modules/ECMOptionalAddSubdirectory.cmake +++ b/modules/ECMOptionalAddSubdirectory.cmake @@ -1,7 +1,10 @@ # - ECM_OPTIONAL_ADD_SUBDIRECTORY() combines ADD_SUBDIRECTORY() with an OPTION() +# # ECM_OPTIONAL_ADD_SUBDIRECTORY(<dir>) +# # If you use ECM_OPTIONAL_ADD_SUBDIRECTORY() instead of ADD_SUBDIRECTORY(), # this will have two effects +# # 1 - CMake will not complain if the directory doesn't exist # This makes sense if you want to distribute just one of the subdirs # in a source package, e.g. just one of the subdirs in kdeextragear. diff --git a/modules/ECMPrintVariables.cmake b/modules/ECMPrintVariables.cmake index b447cc0b..f1ae4796 100644 --- a/modules/ECMPrintVariables.cmake +++ b/modules/ECMPrintVariables.cmake @@ -1,4 +1,5 @@ # - Convenience macro for printing the values of cmake variables, useful e.g. while debugging. +# # ECM_PRINT_VARIABLES(var1 var2 .. varN) # # This macro will print the name of each variable followed by its value. diff --git a/modules/ECMSetVersionVariables.cmake b/modules/ECMSetVersionVariables.cmake index db7f7888..561358a8 100644 --- a/modules/ECMSetVersionVariables.cmake +++ b/modules/ECMSetVersionVariables.cmake @@ -1,4 +1,5 @@ # - Convenience macro for setting version variables. +# # ECM_SET_VERSION_VARIABLES(<prefix> <major> <minor> <patch>) # # This macro sets the following variables: |