ENH: Clarified documentation further.

This commit is contained in:
Brad King 2005-08-03 16:10:59 -04:00
parent b8c789a5da
commit 674fdf8771
1 changed files with 10 additions and 5 deletions

View File

@ -51,7 +51,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Add an dependency to a target"; return "Add a dependency between top-level targets.";
} }
/** /**
@ -62,10 +62,15 @@ public:
return return
" ADD_DEPENDENCIES(target-name depend-target1\n" " ADD_DEPENDENCIES(target-name depend-target1\n"
" depend-target2 ...)\n" " depend-target2 ...)\n"
"Add a dependency to a target. This is only used to add dependencies " "Make a top-level target depend on other top-level targets. A "
"between targets that cannot be inferred from the library/executable " "top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, "
"links that are specified. Regular build dependencies are " "or ADD_CUSTOM_TARGET. Adding dependencies with this command "
"handled automatically."; "can be used to make sure one target is built before another target. "
"See the DEPENDS option of ADD_CUSTOM_TARGET "
"and ADD_CUSTOM_COMMAND for adding file-level dependencies in custom "
"rules. See the OBJECT_DEPENDS option in "
"SET_SOURCE_FILES_PROPERTIES to add file-level dependencies to object "
"files.";
} }
cmTypeMacro(cmAddDependenciesCommand, cmCommand); cmTypeMacro(cmAddDependenciesCommand, cmCommand);