summaryrefslogtreecommitdiffstats
path: root/Source/cmAuxSourceDirectoryCommand.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/cmAuxSourceDirectoryCommand.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/cmAuxSourceDirectoryCommand.h')
-rw-r--r--Source/cmAuxSourceDirectoryCommand.h32
1 files changed, 0 insertions, 32 deletions
diff --git a/Source/cmAuxSourceDirectoryCommand.h b/Source/cmAuxSourceDirectoryCommand.h
index 8a70f19..8b5fa8a 100644
--- a/Source/cmAuxSourceDirectoryCommand.h
+++ b/Source/cmAuxSourceDirectoryCommand.h
@@ -46,38 +46,6 @@ public:
*/
virtual const char* GetName() const { return "aux_source_directory";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Find all source files in a directory.";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " aux_source_directory(<dir> <variable>)\n"
- "Collects the names of all the source files in the specified "
- "directory and stores the list in the <variable> provided. This "
- "command is intended to be used by projects that use explicit "
- "template instantiation. Template instantiation files can be "
- "stored in a \"Templates\" subdirectory and collected automatically "
- "using this command to avoid manually listing all instantiations.\n"
- "It is tempting to use this command to avoid writing the list of "
- "source files for a library or executable target. While this seems "
- "to work, there is no way for CMake to generate a build system that "
- "knows when a new source file has been added. Normally the "
- "generated build system knows when it needs to rerun CMake because "
- "the CMakeLists.txt file is modified to add a new source. When the "
- "source is just added to the directory without modifying this file, "
- "one would have to manually rerun CMake to generate a build system "
- "incorporating the new file.";
- }
-
cmTypeMacro(cmAuxSourceDirectoryCommand, cmCommand);
};