Help: Format project command and variable documentation

Also add document for CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE variable.
This commit is contained in:
Brad King
2014-01-29 09:00:40 -05:00
parent 8157f58d02
commit 00007dcc36
8 changed files with 38 additions and 27 deletions

View File

@@ -0,0 +1,6 @@
CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE
------------------------------------
A CMake language file or module to be included by the :command:`project`
command. This is is intended for injecting custom code into project
builds without modifying their source.

View File

@@ -3,6 +3,6 @@
Top level binary directory for the named project.
A variable is created with the name used in the PROJECT command, and
is the binary directory for the project. This can be useful when
SUBDIR is used to connect several projects.
A variable is created with the name used in the :command:`project` command,
and is the binary directory for the project. This can be useful when
:command:`add_subdirectory` is used to connect several projects.

View File

@@ -3,6 +3,6 @@
Top level source directory for the named project.
A variable is created with the name used in the PROJECT command, and
is the source directory for the project. This can be useful when
add_subdirectory is used to connect several projects.
A variable is created with the name used in the :command:`project` command,
and is the source directory for the project. This can be useful when
:command:`add_subdirectory` is used to connect several projects.

View File

@@ -3,4 +3,4 @@ PROJECT_BINARY_DIR
Full path to build directory for project.
This is the binary directory of the most recent PROJECT command.
This is the binary directory of the most recent :command:`project` command.

View File

@@ -3,4 +3,4 @@ PROJECT_NAME
Name of the project given to the project command.
This is the name given to the most recent PROJECT command.
This is the name given to the most recent :command:`project` command.

View File

@@ -3,4 +3,4 @@ PROJECT_SOURCE_DIR
Top level source directory for the current project.
This is the source directory of the most recent PROJECT command.
This is the source directory of the most recent :command:`project` command.