summaryrefslogtreecommitdiffstats
path: root/Source/cmVTKMakeInstantiatorCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
committerBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmVTKMakeInstantiatorCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadCMake-a02574158d178615cf8fd642695e5099b6041049.zip
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.bz2
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmVTKMakeInstantiatorCommand.h')
-rw-r--r--Source/cmVTKMakeInstantiatorCommand.h45
1 files changed, 23 insertions, 22 deletions
diff --git a/Source/cmVTKMakeInstantiatorCommand.h b/Source/cmVTKMakeInstantiatorCommand.h
index f1cbb2f..658cea7 100644
--- a/Source/cmVTKMakeInstantiatorCommand.h
+++ b/Source/cmVTKMakeInstantiatorCommand.h
@@ -45,34 +45,35 @@ public:
/** Succinct documentation. */
virtual const char* GetTerseDocumentation()
{
- return "Register classes for creation by vtkInstantiator";
+ return "Deprecated. For use only in VTK 4.0.";
}
/** More documentation. */
virtual const char* GetFullDocumentation()
{
return
- "VTK_MAKE_INSTANTIATOR(className outSourceList\n"
- " src-list1 [src-list2 ..]\n"
- " EXPORT_MACRO exportMacro\n"
- " [HEADER_LOCATION dir] [GROUP_SIZE groupSize]\n"
- " [INCLUDES [file1 file2 ..]])\n"
- "Generates a new class with the given name and adds its files to the\n"
- "given outSourceList. It registers the classes from the other given\n"
- "source lists with vtkInstantiator when it is loaded. The output\n"
- "source list should be added to the library with the classes it\n"
- "registers.\n"
- "The EXPORT_MACRO argument must be given and followed by the export\n"
- "macro to use when generating the class (ex. VTK_COMMON_EXPORT).\n"
- "The HEADER_LOCATION option must be followed by a path. It specifies\n"
- "the directory in which to place the generated class's header file.\n"
- "The generated class implementation files always go in the build\n"
- "directory corresponding to the CMakeLists.txt file containing\n"
- "the command. This is the default location for the header.\n"
- "The INCLUDES option can be followed by a list of zero or more files.\n"
- "These files will be #included by the generated instantiator header,\n"
- "and can be used to gain access to the specified exportMacro in the\n"
- " C++ code.";
+ " VTK_MAKE_INSTANTIATOR(className outSourceList\n"
+ " src-list1 [src-list2 ..]\n"
+ " EXPORT_MACRO exportMacro\n"
+ " [HEADER_LOCATION dir]\n"
+ " [GROUP_SIZE groupSize]\n"
+ " [INCLUDES [file1 file2 ..]])\n"
+ "Generates a new class with the given name and adds its files to the "
+ "given outSourceList. It registers the classes from the other given "
+ "source lists with vtkInstantiator when it is loaded. The output "
+ "source list should be added to the library with the classes it "
+ "registers. "
+ "The EXPORT_MACRO argument must be given and followed by the export "
+ "macro to use when generating the class (ex. VTK_COMMON_EXPORT). "
+ "The HEADER_LOCATION option must be followed by a path. It specifies "
+ "the directory in which to place the generated class's header file. "
+ "The generated class implementation files always go in the build "
+ "directory corresponding to the CMakeLists.txt file containing "
+ "the command. This is the default location for the header. "
+ "The INCLUDES option can be followed by a list of zero or more files. "
+ "These files will be #included by the generated instantiator header, "
+ "and can be used to gain access to the specified exportMacro in the "
+ "C++ code.";
}
cmTypeMacro(cmVTKMakeInstantiatorCommand, cmCommand);