summaryrefslogtreecommitdiffstats
path: root/Source/cmAddExecutableCommand.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/cmAddExecutableCommand.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/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);
};