summaryrefslogtreecommitdiffstats
path: root/Source/cmAddCustomTargetCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-16 13:28:12 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-10-16 13:28:12 (GMT)
commitc49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch)
tree96102c69673467ce7b922697cd5f378511249201 /Source/cmAddCustomTargetCommand.h
parent5029da5eac08171653a92b961c341f7ffcca3640 (diff)
parent7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff)
downloadCMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation a77e308 CPack: Replace #<type> markup with reStructuredText equivalent e7ca48f Help: Factor out cmake-generator-expressions manual page 97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication 8982161 Help: Factor out find_* command duplication 30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication bfe07aa Build Help documentation during CMake build using Sphinx 53ded59 Drop unused builtin documentation APIs 0c39a75 Drop the 'Full' field from cmDocumentationEntry e33d8d2 Drop builtin command documentation 399e9c4 Drop builtin property documentation 6035c04 get_property: Drop test for builtin property documentation 80a3273 Drop all documentation formatters except Usage b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents ec6df36 Teach --help-* options to load documentation from .rst files 25f2877 Add class cmRST to do basic reStructuredText processing ...
Diffstat (limited to 'Source/cmAddCustomTargetCommand.h')
-rw-r--r--Source/cmAddCustomTargetCommand.h57
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);
};