]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Add a bunch of comments
authormaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 26 Sep 2012 09:08:14 +0000 (09:08 +0000)
committermaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 26 Sep 2012 09:08:14 +0000 (09:08 +0000)
git-svn-id: https://svn.dealii.org/branches/branch_cmake@26748 0785d39b-7218-0410-832d-ea1e28bc413d

13 files changed:
deal.II/cmake/macros/macro_add_flags.cmake
deal.II/cmake/macros/macro_check_cxx_compiler_bug.cmake
deal.II/cmake/macros/macro_cond_set_to_yes.cmake
deal.II/cmake/macros/macro_configure_feature.cmake
deal.II/cmake/macros/macro_deal_ii_add_c_library.cmake
deal.II/cmake/macros/macro_deal_ii_add_definitions.cmake
deal.II/cmake/macros/macro_deal_ii_add_library.cmake
deal.II/cmake/macros/macro_enable_if_supported.cmake
deal.II/cmake/macros/macro_expand_instantiations.cmake
deal.II/cmake/macros/macro_set_if_empty.cmake
deal.II/cmake/macros/macro_strip_flag.cmake
deal.II/cmake/macros/macro_to_string.cmake
deal.II/cmake/macros/macro_to_string_and_add_prefix.cmake

index 2a84224afefef9e89ed77cece988e30829eb3245..d35338ee9b528b3862cced91b705fbc60e1866ee 100644 (file)
@@ -1,6 +1,6 @@
 #
-# A small macro used for (string-)appending a string flags to a
-# string variable
+# A small macro used for (string-)appending a string "${flags}" to a
+# string "${variable}"
 #
 # Usage:
 #     ADD_FLAGS(variable flags)
index d69350adc8e87aef4426e312485c7678d004dde8..da4631c81583dd2b536abe0ed212dd2ada915eff 100644 (file)
@@ -2,10 +2,10 @@
 # Check for a compiler bug.
 #
 # Usage:
-#     CHECK_CXX_COMPILER_BUG(source var)
+#     CHECK_CXX_COMPILER_BUG(source var),
 #
 # where source is a snipped of source code and var is a variable that will
-# be set to true if source could not be compiled and linked successfully.
+# be set to true if the source could not be compiled and linked successfully.
 # (This just inverts the logic of CHECK_CXX_SOURCE_COMPILES.)
 #
 
index 55dcd8346aa988a01927be696b5d46ae475b27d6..ded704afa597af5aba10756e5e5628ea00d0350e 100644 (file)
@@ -1,6 +1,6 @@
-
 #
-# IF(bool), set variable to "yes".
+# If bool is "true" (in a cmake fashion...), set variable to "yes",
+# otherwise to "no".
 #
 # Usage:
 #     COND_SET_TO_YES(bool variable)
index 87b465e6a1ba3a4c7b4808ab78a143b6283c52c8..e41eb63aa15514ed912f253c62594e59ea62e718 100644 (file)
@@ -8,11 +8,11 @@
 # For a feature ${feature} (written in all caps) the following options,
 # variables and macros have to be defined (except marked as optional):
 #
-# DEAL_II_WITH_${feature} (option, mandatory)
-#    determines whether the feature will be configured, if
-#    DEAL_II_FEATURE_AUTODETECTION is OFF. If
-#    DEAL_II_FEATURE_AUTODETECTION is ON, this option will be set if
-#    configuring the feature was successful.
+# DEAL_II_WITH_${feature} (bool, mandatory)
+#    If DEAL_II_FEATURE_AUTODETECTION is OFF, this boolean determines
+#    whether the feature will be configured.
+#    If DEAL_II_FEATURE_AUTODETECTION is ON, this boolean will
+#    automatically be set if configuring the feature was successful.
 #
 # FEATURE_${feature}_DEPENDS (variable, optional)
 #    a variable which contains an optional list of other features
@@ -38,7 +38,6 @@
 #    This macro should give an error (SEND_ERROR or FATAL_ERROR).
 #
 # FEATURE_${feature}_CONFIGURE_EXTERNAL(var)  (macro, mandatory)
-#
 #    which should setup all necessary configuration for the feature with
 #    external dependencies. var set to TRUE indicates success,
 #    otherwise this script gives an error.
index 7200ca393129a29b0d010ae1656d989fef35e12b..1e5166230fc77d8465244b541e15c162d40bba69 100644 (file)
@@ -1,6 +1,5 @@
-
 #
-# TODO: A comment
+# See macro_deal_ii_add_library.cmake for an explanation of this macro
 #
 
 MACRO(DEAL_II_ADD_C_LIBRARY library)
index d99e9c8e863f41fc8696caebd7452f4b6abf3344..cba2b82152f358769653be57365181e1cc2de2e3 100644 (file)
@@ -1,6 +1,7 @@
-
 #
-# TODO: A comment
+# A small wrapper around
+# SET_TARGET_PROPERTY(... PROPERTIES COMPILE_DEFINITIONS ...)
+# to _add_ compile definitions to every target we have specified.
 #
 
 MACRO(DEAL_II_ADD_DEFINITIONS name)
index 297ce5bf4e00ca5712c80f834a9475102ec5ea9e..3f1758025e342b170dd3606ad3f1df1609f4cb8f 100644 (file)
@@ -1,6 +1,16 @@
-
 #
-# TODO: A comment
+# A small wrapper around ADD_LIBRARY that will define a target for each
+# build type specified in DEAL_II_BUILD_TYPES
+#
+# It is assumed that the desired compilation configuration is set via
+#   DEAL_II_SHARED_LINKER_FLAGS_${build}
+#   DEAL_II_CXX_FLAGS_${build}
+#   DEAL_II_DEFINITIONS_${build}
+#
+# as well as the global (for all build types)
+#   CMAKE_SHARED_LINKER_FLAGS
+#   CMAKE_CXX_FLAGS
+#   DEAL_II_DEFINITIONS
 #
 
 MACRO(DEAL_II_ADD_LIBRARY library)
index c936958d888ce470560fb16fe214bc9fb5aa1954..8431652f6b4ed4428f27f16706a632b124856dc1 100644 (file)
@@ -1,6 +1,6 @@
 #
-# Tests whether the cxx compiler understands flag. If so, add it to
-# variable.
+# Tests whether the cxx compiler understands a flag.
+# If so, add it to 'variable'.
 #
 # Usage:
 #     ENABLE_IF_SUPPORTED(variable flag)
index f923b0d8c428bc6178f0c98b0347f7c236c8316e..7fd48d1cbe38af7fd581b2b08a5006d8b90767fa 100644 (file)
@@ -8,8 +8,9 @@
 #
 # target
 #
-#    a target that will depend on the generation of all .inst files.
-#    (To ensure that all .inst files are generated prior to compiling.)
+#    where target.${build_type} will depend on the generation of all .inst
+#    files, to ensure that all .inst files are generated prior to
+#    compiling.
 #
 # inst_in_files
 #
@@ -40,8 +41,8 @@ MACRO(EXPAND_INSTANTIATIONS target inst_in_files)
   ADD_CUSTOM_TARGET(${target}.inst ALL DEPENDS ${inst_targets})
 
   #
-  # Add a dependency to target so that target.inst is fully generated
-  # before target will be processed.
+  # Add a dependency to all target.${build_type} so that target.inst is
+  # fully generated before target will be processed.
   #
   FOREACH(build ${DEAL_II_BUILD_TYPES})
     STRING(TOLOWER ${build} build_lowercase)
index bb24d653571fcac2ea28fcc388c3e6ed490f6ad0..6d530f1d7b451cbd723a1926a4795a43e66e32ab 100644 (file)
@@ -1,4 +1,6 @@
-
+#
+# If 'variable' is empty it will be set to 'value'
+#
 MACRO(SET_IF_EMPTY variable value)
   IF("${${variable}}" STREQUAL "")
     SET(${variable} ${value})
index bbf571e48bb5300489d705e2cfcab1556448b81b..9aa458f380d51b08b52ed6ec78a7669c4970548f 100644 (file)
@@ -6,12 +6,8 @@
 #
 
 MACRO(STRIP_FLAG variable flag)
-  IF(NOT "${variable}" STREQUAL "")
-    SET(${variable} " ${${variable}}")
-    STRING(REPLACE " ${flag}" "" ${variable} ${${variable}})
-    IF(NOT "${variable}" STREQUAL "")
-      STRING(STRIP ${${variable}} ${variable})
-    ENDIF()
-  ENDIF()
+  SET(${variable} " ${${variable}}")
+  STRING(REPLACE " ${flag}" "" "${variable}" ${${variable}})
+  STRING(STRIP "${${variable}}" ${variable})
 ENDMACRO()
 
index 7bdb48c68c59d761e652d188682eea818565c323..886908c06ad02bdc337c5d23e90b2c80dfb025c1 100644 (file)
@@ -1,4 +1,3 @@
-
 #
 # A small macro used for converting a list into a space
 # separated string:
index 7df7da7bbda9a981bb1a8ff0aced9c80f6d18551..e1c11e0287cd73dda54d0ff7e0c80fb421efcbc4 100644 (file)
@@ -1,4 +1,3 @@
-
 #
 # A small macro used for converting a cmake list into a space
 # separated string. This macro adds the string "prefix" in front of each

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.