summaryrefslogtreecommitdiffstats
path: root/Modules/FindALSA.cmake
diff options
context:
space:
mode:
authorRolf Eike Beer <eb@emlix.com>2018-05-28 13:52:08 (GMT)
committerRolf Eike Beer <eike@sf-mail.de>2018-05-31 07:35:53 (GMT)
commit6a64292fa722c15b8af63e3b0b4dcef5dbfacc8e (patch)
treee0a04a66a81eb8e5e766a3f6c7d4f4520a1ff549 /Modules/FindALSA.cmake
parent1c87844856f7995bccc30c32567540be948f80da (diff)
downloadCMake-6a64292fa722c15b8af63e3b0b4dcef5dbfacc8e.zip
CMake-6a64292fa722c15b8af63e3b0b4dcef5dbfacc8e.tar.gz
CMake-6a64292fa722c15b8af63e3b0b4dcef5dbfacc8e.tar.bz2
FindALSA: reformat docs
Diffstat (limited to 'Modules/FindALSA.cmake')
-rw-r--r--Modules/FindALSA.cmake25
1 files changed, 16 insertions, 9 deletions
diff --git a/Modules/FindALSA.cmake b/Modules/FindALSA.cmake
index 84b6ec5..c9cfd60 100644
--- a/Modules/FindALSA.cmake
+++ b/Modules/FindALSA.cmake
@@ -18,20 +18,27 @@
# Result Variables
# ^^^^^^^^^^^^^^^^
#
-# ::
+# This module defines the following variables:
#
-# This module defines the following variables:
-# ALSA_FOUND - True if ALSA_INCLUDE_DIR & ALSA_LIBRARY are found
-# ALSA_LIBRARIES - Set when ALSA_LIBRARY is found
-# ALSA_INCLUDE_DIRS - Set when ALSA_INCLUDE_DIR is found
+# ``ALSA_FOUND``
+# True if ALSA_INCLUDE_DIR & ALSA_LIBRARY are found
#
+# ``ALSA_LIBRARIES``
+# List of libraries when using ALSA.
#
+# ``ALSA_INCLUDE_DIRS``
+# Where to find the ALSA headers.
#
-# ::
+# Cache variables
+# ^^^^^^^^^^^^^^^
#
-# ALSA_INCLUDE_DIR - where to find asoundlib.h, etc.
-# ALSA_LIBRARY - the asound library
-# ALSA_VERSION_STRING - the version of alsa found (since CMake 2.8.8)
+# The following cache variables may also be set:
+#
+# ``ALSA_INCLUDE_DIR``
+# the ALSA include directory
+#
+# ``ALSA_LIBRARY``
+# the absolute path of the asound library
find_path(ALSA_INCLUDE_DIR NAMES alsa/asoundlib.h
DOC "The ALSA (asound) include directory"