diff options
author | Brad King <brad.king@kitware.com> | 2013-09-17 17:23:40 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:36 (GMT) |
commit | e33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch) | |
tree | 03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmAddCustomTargetCommand.h | |
parent | 399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff) | |
download | CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.zip CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.gz CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.bz2 |
Drop builtin command documentation
Drop all GetTerseDocumentation and GetFullDocumentation methods from
commands. The command documentation is now in Help/command/*.rst files.
Diffstat (limited to 'Source/cmAddCustomTargetCommand.h')
-rw-r--r-- | Source/cmAddCustomTargetCommand.h | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/Source/cmAddCustomTargetCommand.h b/Source/cmAddCustomTargetCommand.h index d4ed450..d0fcdad 100644 --- a/Source/cmAddCustomTargetCommand.h +++ b/Source/cmAddCustomTargetCommand.h @@ -45,63 +45,6 @@ public: virtual const char* GetName() const {return "add_custom_target";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a target with no output so it will always be built."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_custom_target(Name [ALL] [command1 [args1...]]\n" - " [COMMAND command2 [args2...] ...]\n" - " [DEPENDS depend depend depend ... ]\n" - " [WORKING_DIRECTORY dir]\n" - " [COMMENT comment] [VERBATIM]\n" - " [SOURCES src1 [src2...]])\n" - "Adds a target with the given name that executes the given commands. " - "The target has no output file and is ALWAYS CONSIDERED OUT OF DATE " - "even if the commands try to create a file with the name of the " - "target. Use ADD_CUSTOM_COMMAND to generate a file with dependencies. " - "By default nothing depends on the custom target. Use " - "ADD_DEPENDENCIES to add dependencies to or from other targets. " - "If the ALL option is specified " - "it indicates that this target should be added to the default build " - "target so that it will be run every time " - "(the command cannot be called ALL). " - "The command and arguments are optional and if not specified an " - "empty target will be created. " - "If WORKING_DIRECTORY is set, then the command will be run in that " - "directory. " - "If it is a relative path it will be interpreted relative to the " - "build tree directory corresponding to the current source directory. " - "If COMMENT is set, the value will be displayed as a " - "message before the commands are executed at build time. " - "Dependencies listed with the DEPENDS argument may reference files " - "and outputs of custom commands created with add_custom_command() in " - "the same directory (CMakeLists.txt file).\n" - "If VERBATIM is given then all arguments to the commands will be " - "escaped properly for the build tool so that the invoked command " - "receives each argument unchanged. " - "Note that one level of escapes is still used by the CMake language " - "processor before add_custom_target even sees the arguments. " - "Use of VERBATIM is recommended as it enables correct behavior. " - "When VERBATIM is not given the behavior is platform specific because " - "there is no protection of tool-specific special characters." - "\n" - "The SOURCES option specifies additional source files to be included " - "in the custom target. " - "Specified source files will be added to IDE project files for " - "convenience in editing even if they have not build rules." - ; - } - cmTypeMacro(cmAddCustomTargetCommand, cmCommand); }; |