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/cmGetFilenameComponentCommand.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/cmGetFilenameComponentCommand.h')
-rw-r--r-- | Source/cmGetFilenameComponentCommand.h | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/Source/cmGetFilenameComponentCommand.h b/Source/cmGetFilenameComponentCommand.h index 09af332..e2cd219 100644 --- a/Source/cmGetFilenameComponentCommand.h +++ b/Source/cmGetFilenameComponentCommand.h @@ -48,43 +48,6 @@ public: */ virtual const char* GetName() const { return "get_filename_component";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a specific component of a full filename."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_filename_component(<VAR> <FileName> <COMP> [CACHE])\n" - "Set <VAR> to a component of <FileName>, where <COMP> is one of:\n" - " DIRECTORY = Directory without file name\n" - " NAME = File name without directory\n" - " EXT = File name longest extension (.b.c from d/a.b.c)\n" - " NAME_WE = File name without directory or longest extension\n" - " ABSOLUTE = Full path to file\n" - " REALPATH = Full path to existing file with symlinks resolved\n" - " PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)\n" - "Paths are returned with forward slashes and have no trailing slahes. " - "The longest file extension is always considered. " - "If the optional CACHE argument is specified, the result variable is " - "added to the cache.\n" - " get_filename_component(<VAR> FileName\n" - " PROGRAM [PROGRAM_ARGS <ARG_VAR>]\n" - " [CACHE])\n" - "The program in FileName will be found in the system search path or " - "left as a full path. If PROGRAM_ARGS is present with PROGRAM, then " - "any command-line arguments present in the FileName string are split " - "from the program name and stored in <ARG_VAR>. This is used to " - "separate a program name from its arguments in a command line string."; - } - cmTypeMacro(cmGetFilenameComponentCommand, cmCommand); }; |