summaryrefslogtreecommitdiffstats
path: root/Source/cmAddExecutableCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-17 17:23:40 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 13:22:36 (GMT)
commite33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch)
tree03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmAddExecutableCommand.h
parent399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff)
downloadCMake-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/cmAddExecutableCommand.h')
-rw-r--r--Source/cmAddExecutableCommand.h80
1 files changed, 0 insertions, 80 deletions
diff --git a/Source/cmAddExecutableCommand.h b/Source/cmAddExecutableCommand.h
index 2774ce8..30ecce3 100644
--- a/Source/cmAddExecutableCommand.h
+++ b/Source/cmAddExecutableCommand.h
@@ -43,86 +43,6 @@ public:
*/
virtual const char* GetName() const { return "add_executable";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return
- "Add an executable to the project using the specified source files.";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " add_executable(<name> [WIN32] [MACOSX_BUNDLE]\n"
- " [EXCLUDE_FROM_ALL]\n"
- " source1 source2 ... sourceN)\n"
- "Adds an executable target called <name> to be built from the "
- "source files listed in the command invocation. "
- "The <name> corresponds to the logical target name and must be "
- "globally unique within a project. "
- "The actual file name of the executable built is constructed based on "
- "conventions of the native platform "
- "(such as <name>.exe or just <name>). "
- "\n"
- "By default the executable file will be created in the build tree "
- "directory corresponding to the source tree directory in which "
- "the command was invoked. "
- "See documentation of the RUNTIME_OUTPUT_DIRECTORY "
- "target property to change this location. "
- "See documentation of the OUTPUT_NAME target property to change "
- "the <name> part of the final file name. "
- "\n"
- "If WIN32 is given the property WIN32_EXECUTABLE will be set on the "
- "target created. "
- "See documentation of that target property for details."
- "\n"
- "If MACOSX_BUNDLE is given the corresponding property will be "
- "set on the created target. "
- "See documentation of the MACOSX_BUNDLE target property for details."
- "\n"
- "If EXCLUDE_FROM_ALL is given the corresponding property will be "
- "set on the created target. "
- "See documentation of the EXCLUDE_FROM_ALL target property for "
- "details."
- "\n"
- "The add_executable command can also create IMPORTED executable "
- "targets using this signature:\n"
- " add_executable(<name> IMPORTED [GLOBAL])\n"
- "An IMPORTED executable target references an executable file located "
- "outside the project. "
- "No rules are generated to build it. "
- "The target name has scope in the directory in which it is created "
- "and below, but the GLOBAL option extends visibility. "
- "It may be referenced like any target built within the project. "
- "IMPORTED executables are useful for convenient reference from "
- "commands like add_custom_command. "
- "Details about the imported executable are specified by setting "
- "properties whose names begin in \"IMPORTED_\". "
- "The most important such property is IMPORTED_LOCATION "
- "(and its per-configuration version IMPORTED_LOCATION_<CONFIG>) "
- "which specifies the location of the main executable file on disk. "
- "See documentation of the IMPORTED_* properties for more information."
- "\n"
- "The signature\n"
- " add_executable(<name> ALIAS <target>)\n"
- "creates an alias, such that <name> can be used to refer to <target> "
- "in subsequent commands. The <name> does not appear in the generated "
- "buildsystem as a make target. The <target> may not be an IMPORTED "
- "target or an ALIAS. Alias targets can be used as linkable targets, "
- "targets to read properties from, executables for custom commands and "
- "custom targets. They can also be tested for existance with the "
- "regular if(TARGET) subcommand. The <name> may not be used to modify "
- "properties of <target>, that is, it may not be used as the operand of "
- "set_property, set_target_properties, target_link_libraries etc. An "
- "ALIAS target may not be installed of exported."
- ;
- }
-
cmTypeMacro(cmAddExecutableCommand, cmCommand);
};