summaryrefslogtreecommitdiffstats
path: root/Modules/FindPackageMessage.cmake
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/FindPackageMessage.cmake
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Modules/FindPackageMessage.cmake')
-rw-r--r--Modules/FindPackageMessage.cmake36
1 files changed, 22 insertions, 14 deletions
diff --git a/Modules/FindPackageMessage.cmake b/Modules/FindPackageMessage.cmake
index 5cea43e..b6a58e4 100644
--- a/Modules/FindPackageMessage.cmake
+++ b/Modules/FindPackageMessage.cmake
@@ -1,22 +1,30 @@
+#.rst:
+# FindPackageMessage
+# ------------------
+#
+#
+#
# FIND_PACKAGE_MESSAGE(<name> "message for user" "find result details")
#
-# This macro is intended to be used in FindXXX.cmake modules files.
-# It will print a message once for each unique find result.
-# This is useful for telling the user where a package was found.
-# The first argument specifies the name (XXX) of the package.
-# The second argument specifies the message to display.
-# The third argument lists details about the find result so that
-# if they change the message will be displayed again.
-# The macro also obeys the QUIET argument to the find_package command.
+# This macro is intended to be used in FindXXX.cmake modules files. It
+# will print a message once for each unique find result. This is useful
+# for telling the user where a package was found. The first argument
+# specifies the name (XXX) of the package. The second argument
+# specifies the message to display. The third argument lists details
+# about the find result so that if they change the message will be
+# displayed again. The macro also obeys the QUIET argument to the
+# find_package command.
#
# Example:
#
-# if(X11_FOUND)
-# FIND_PACKAGE_MESSAGE(X11 "Found X11: ${X11_X11_LIB}"
-# "[${X11_X11_LIB}][${X11_INCLUDE_DIR}]")
-# else()
-# ...
-# endif()
+# ::
+#
+# if(X11_FOUND)
+# FIND_PACKAGE_MESSAGE(X11 "Found X11: ${X11_X11_LIB}"
+# "[${X11_X11_LIB}][${X11_INCLUDE_DIR}]")
+# else()
+# ...
+# endif()
#=============================================================================
# Copyright 2008-2009 Kitware, Inc.