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/cmAddSubDirectoryCommand.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/cmAddSubDirectoryCommand.h')
-rw-r--r-- | Source/cmAddSubDirectoryCommand.h | 47 |
1 files changed, 0 insertions, 47 deletions
diff --git a/Source/cmAddSubDirectoryCommand.h b/Source/cmAddSubDirectoryCommand.h index e7f907c..1e5b1ab 100644 --- a/Source/cmAddSubDirectoryCommand.h +++ b/Source/cmAddSubDirectoryCommand.h @@ -44,53 +44,6 @@ public: */ virtual const char* GetName() const { return "add_subdirectory";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a subdirectory to the build."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_subdirectory(source_dir [binary_dir] \n" - " [EXCLUDE_FROM_ALL])\n" - "Add a subdirectory to the build. The source_dir specifies the " - "directory in which the source CMakeLists.txt and code files are " - "located. If it is a relative " - "path it will be evaluated with respect to the current " - "directory (the typical usage), but it may also be an absolute path. " - "The binary_dir specifies the directory in which to place the output " - "files. If it is a relative path it will be evaluated with respect " - "to the current output directory, but it may also be an absolute " - "path. If binary_dir is not specified, the value of source_dir, " - "before expanding any relative path, will be used (the typical usage). " - "The CMakeLists.txt file in the specified source directory will " - "be processed immediately by CMake before processing in the current " - "input file continues beyond this command.\n" - - "If the EXCLUDE_FROM_ALL argument is provided then targets in the " - "subdirectory will not be included in the ALL target of the parent " - "directory by default, and will be excluded from IDE project files. " - "Users must explicitly build targets in the subdirectory. " - "This is meant for use when the subdirectory contains a separate part " - "of the project that is useful but not necessary, such as a set of " - "examples. " - "Typically the subdirectory should contain its own project() command " - "invocation so that a full build system will be generated in the " - "subdirectory (such as a VS IDE solution file). " - "Note that inter-target dependencies supercede this exclusion. " - "If a target built by the parent project depends on a target in the " - "subdirectory, the dependee target will be included in the parent " - "project build system to satisfy the dependency." - ; - } - cmTypeMacro(cmAddSubDirectoryCommand, cmCommand); }; |