summaryrefslogtreecommitdiffstats
path: root/Source/cmake.h
diff options
context:
space:
mode:
authorYury G. Kudryashov <urkud.urkud@gmail.com>2012-02-25 22:21:39 (GMT)
committerYury G. Kudryashov <urkud.urkud@gmail.com>2012-02-28 20:18:11 (GMT)
commit1e5b971ed0346849243ecbcd05443404ebf7a3cb (patch)
tree852b21badde5540de1456fb38f4700188615b59f /Source/cmake.h
parent54ab11c0d23fcd015ec2e5686524ac9c746ed0ca (diff)
downloadCMake-1e5b971ed0346849243ecbcd05443404ebf7a3cb.zip
CMake-1e5b971ed0346849243ecbcd05443404ebf7a3cb.tar.gz
CMake-1e5b971ed0346849243ecbcd05443404ebf7a3cb.tar.bz2
doxygen: Use proper syntax to document enum
Diffstat (limited to 'Source/cmake.h')
-rw-r--r--Source/cmake.h27
1 files changed, 15 insertions, 12 deletions
diff --git a/Source/cmake.h b/Source/cmake.h
index 31b1bb7..cfa747e 100644
--- a/Source/cmake.h
+++ b/Source/cmake.h
@@ -66,21 +66,24 @@ class cmake
};
- /** Describes the working modes of cmake.
- * NORMAL_MODE: cmake runs to create project files
- * SCRIPT_MODE: in script mode there is no generator and no cache. Also,
- * language are not enabled, so add_executable and things do
- * not do anything. Started by using -P
- * FIND_PACKAGE_MODE: cmake runs in pkg-config like mode, i.e. it just
- * searches for a package and prints the results to stdout.
- * This is similar to SCRIPT_MODE, but commands like
- * add_library() work too, since they may be used e.g. in
- * exported target files. Started via --find-package
- */
+ /** \brief Describes the working modes of cmake */
enum WorkingMode
{
- NORMAL_MODE,
+ NORMAL_MODE, ///< Cmake runs to create project files
+ /** \brief Script mode (started by using -P).
+ *
+ * In script mode there is no generator and no cache. Also,
+ * languages are not enabled, so add_executable and things do
+ * nothing.
+ */
SCRIPT_MODE,
+ /** \brief A pkg-config like mode
+ *
+ * In this mode cmake just searches for a package and prints the results to
+ * stdout. This is similar to SCRIPT_MODE, but commands like add_library()
+ * work too, since they may be used e.g. in exported target files. Started
+ * via --find-package.
+ */
FIND_PACKAGE_MODE
};
typedef std::map<cmStdString, cmCommand*> RegisteredCommandsMap;