mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-21 22:50:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

Drop builtin command documentation

Browse Source 
Drop all GetTerseDocumentation and GetFullDocumentation methods from
commands.  The command documentation is now in Help/command/*.rst files.
This commit is contained in:
Brad King
2013-09-17 13:23:40 -04:00
parent 399e9c46d8
commit e33d8d2d77
131 changed files with 0 additions and 5529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
Source/cmWriteFileCommand.h
View File

@@ -46,32 +46,6 @@ public:
*/
virtual const char* GetName() const { return "write_file";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
{
return "Deprecated. Use the file(WRITE ) command instead.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
{
return
" write_file(filename \"message to write\"... [APPEND])\n"
"The first argument is the file name, the rest of the arguments are "
"messages to write. If the argument APPEND is specified, then "
"the message will be appended.\n"
"NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as "
"this one but add some more functionality.\n"
"NOTE 2: When using write_file the produced file cannot be used as an "
"input to CMake (CONFIGURE_FILE, source file ...) because it will "
"lead to an infinite loop. Use configure_file if you want to generate "
"input files to CMake.";
}
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged() const
{