Example of builtin variable documentation (i.e. only used in C++ source code).

This commit is contained in:
Eric NOULARD 2012-02-04 12:03:58 +01:00 committed by David Cole
parent 543f1adfa4
commit bafd8a9e79
1 changed files with 15 additions and 7 deletions

View File

@ -1,17 +1,25 @@
#include "cmCPackDocumentVariables.h" #include "cmCPackDocumentVariables.h"
#include "cmake.h" #include "cmake.h"
void cmCPackDocumentVariables::DefineVariables(cmake* ) void cmCPackDocumentVariables::DefineVariables(cmake* cm)
{ {
// Subsection: variables defined/used by cpack, // Subsection: variables defined/used by cpack,
// which are common to all CPack generators // which are common to all CPack generators
// cm->DefineProperty cm->DefineProperty
// ("CPACK_PACKAGE_VENDOR", cmProperty::VARIABLE, ("CPACK_PACKAGING_INSTALL_PREFIX", cmProperty::VARIABLE,
// "The name of the package vendor.", "The prefix used in the built package.",
// "If not specified, defaults to \"Humanity\"." "Each CPack generator has a default value (like /usr)."
// "", false, " This default value may"
// "Variables common to all CPack generators"); " be overwritten from the CMakeLists.txt or the cpack command line"
" by setting an alternative value.\n"
"e.g. "
" set(CPACK_PACKAGING_INSTALL_PREFIX \"/opt\")\n"
"This is not the same purpose as CMAKE_INSTALL_PREFIX which"
" is used when installing from the build tree without building"
" a package."
"", false,
"Variables common to all CPack generators");
// Subsection: variables defined/used by cpack, // Subsection: variables defined/used by cpack,
// which are specific to one CPack generator // which are specific to one CPack generator