浏览代码

STYLE: add documentation for MACRO_ADD_FILE_DEPENDENCIES()

Alex
Alexander Neundorf 16 年之前
父节点
当前提交
1e20be319f
共有 1 个文件被更改,包括 12 次插入6 次删除
  1. 12 6
      Modules/MacroAddFileDependencies.cmake

+ 12 - 6
Modules/MacroAddFileDependencies.cmake

@@ -1,14 +1,20 @@
 # - MACRO_ADD_FILE_DEPENDENCIES(<_file> depend_files...)
-# MACRO_OPTIONAL_FIND_PACKAGE( <name> [QUIT] )
+# Using the macro MACRO_ADD_FILE_DEPENDENCIES() is discouraged. There are usually
+# better ways to specifiy the correct dependencies.
+#
+# MACRO_ADD_FILE_DEPENDENCIES(<_file> depend_files...) is just a convenience 
+# wrapper around the OBJECT_DEPENDS source file property. You can just
+# use SET_PROPERTY(SOURCE <file> APPEND PROPERTY OBJECT_DEPENDS depend_files) instead.
+
 
 MACRO (MACRO_ADD_FILE_DEPENDENCIES _file)
 
    GET_SOURCE_FILE_PROPERTY(_deps ${_file} OBJECT_DEPENDS)
-   if (_deps)
-      set(_deps ${_deps} ${ARGN})
-   else (_deps)
-      set(_deps ${ARGN})
-   endif (_deps)
+   IF (_deps)
+      SET(_deps ${_deps} ${ARGN})
+   ELSE (_deps)
+      SET(_deps ${ARGN})
+   ENDIF (_deps)
 
    SET_SOURCE_FILES_PROPERTIES(${_file} PROPERTIES OBJECT_DEPENDS "${_deps}")