Merge topic 'doc-reStructuredText'

7038a93 Modules/readme.txt: Update steps to add module documentation
a77e308 CPack: Replace #<type> markup with reStructuredText equivalent
e7ca48f Help: Factor out cmake-generator-expressions manual page
97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
8982161 Help: Factor out find_* command duplication
30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
bfe07aa Build Help documentation during CMake build using Sphinx
53ded59 Drop unused builtin documentation APIs
0c39a75 Drop the 'Full' field from cmDocumentationEntry
e33d8d2 Drop builtin command documentation
399e9c4 Drop builtin property documentation
6035c04 get_property: Drop test for builtin property documentation
80a3273 Drop all documentation formatters except Usage
b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents
ec6df36 Teach --help-* options to load documentation from .rst files
25f2877 Add class cmRST to do basic reStructuredText processing
...

1 files changed, 66 insertions, 45 deletions

diff --git a/Modules/FindSDL_sound.cmake b/Modules/FindSDL_sound.cmake
index efd2658..863699a 100644
--- a/Modules/FindSDL_sound.cmake
+++ b/Modules/FindSDL_sound.cmake
@@ -1,59 +1,80 @@
-# - Locates the SDL_sound library
+#.rst:
+# FindSDL_sound
+# -------------
 #
-# This module depends on SDL being found and
-# must be called AFTER FindSDL.cmake is called.
+# Locates the SDL_sound library
+#
+#
+#
+# This module depends on SDL being found and must be called AFTER
+# FindSDL.cmake is called.
 #
 # This module defines
-#  SDL_SOUND_INCLUDE_DIR, where to find SDL_sound.h
-#  SDL_SOUND_FOUND, if false, do not try to link to SDL_sound
-#  SDL_SOUND_LIBRARIES, this contains the list of libraries that you need
-#    to link against. This is a read-only variable and is marked INTERNAL.
-#  SDL_SOUND_EXTRAS, this is an optional variable for you to add your own
-#    flags to SDL_SOUND_LIBRARIES. This is prepended to SDL_SOUND_LIBRARIES.
-#    This is available mostly for cases this module failed to anticipate for
-#    and you must add additional flags. This is marked as ADVANCED.
-#  SDL_SOUND_VERSION_STRING, human-readable string containing the version of SDL_sound
+#
+# ::
+#
+#   SDL_SOUND_INCLUDE_DIR, where to find SDL_sound.h
+#   SDL_SOUND_FOUND, if false, do not try to link to SDL_sound
+#   SDL_SOUND_LIBRARIES, this contains the list of libraries that you need
+#     to link against. This is a read-only variable and is marked INTERNAL.
+#   SDL_SOUND_EXTRAS, this is an optional variable for you to add your own
+#     flags to SDL_SOUND_LIBRARIES. This is prepended to SDL_SOUND_LIBRARIES.
+#     This is available mostly for cases this module failed to anticipate for
+#     and you must add additional flags. This is marked as ADVANCED.
+#   SDL_SOUND_VERSION_STRING, human-readable string containing the version of SDL_sound
+#
+#
 #
 # This module also defines (but you shouldn't need to use directly)
-#   SDL_SOUND_LIBRARY, the name of just the SDL_sound library you would link
-#   against. Use SDL_SOUND_LIBRARIES for you link instructions and not this one.
+#
+# ::
+#
+#    SDL_SOUND_LIBRARY, the name of just the SDL_sound library you would link
+#    against. Use SDL_SOUND_LIBRARIES for you link instructions and not this one.
+#
 # And might define the following as needed
-#   MIKMOD_LIBRARY
-#   MODPLUG_LIBRARY
-#   OGG_LIBRARY
-#   VORBIS_LIBRARY
-#   SMPEG_LIBRARY
-#   FLAC_LIBRARY
-#   SPEEX_LIBRARY
 #
-# Typically, you should not use these variables directly, and you should use
-# SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other audio libraries
-# (if needed) to successfully compile on your system.
+# ::
+#
+#    MIKMOD_LIBRARY
+#    MODPLUG_LIBRARY
+#    OGG_LIBRARY
+#    VORBIS_LIBRARY
+#    SMPEG_LIBRARY
+#    FLAC_LIBRARY
+#    SPEEX_LIBRARY
+#
+#
+#
+# Typically, you should not use these variables directly, and you should
+# use SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other
+# audio libraries (if needed) to successfully compile on your system.
 #
-# Created by Eric Wing.
-# This module is a bit more complicated than the other FindSDL* family modules.
-# The reason is that SDL_sound can be compiled in a large variety of different ways
-# which are independent of platform. SDL_sound may dynamically link against other 3rd
-# party libraries to get additional codec support, such as Ogg Vorbis, SMPEG, ModPlug,
-# MikMod, FLAC, Speex, and potentially others.
-# Under some circumstances which I don't fully understand,
-# there seems to be a requirement
-# that dependent libraries of libraries you use must also be explicitly
-# linked against in order to successfully compile. SDL_sound does not currently
-# have any system in place to know how it was compiled.
-# So this CMake module does the hard work in trying to discover which 3rd party
-# libraries are required for building (if any).
-# This module uses a brute force approach to create a test program that uses SDL_sound,
-# and then tries to build it. If the build fails, it parses the error output for
-# known symbol names to figure out which libraries are needed.
+# Created by Eric Wing.  This module is a bit more complicated than the
+# other FindSDL* family modules.  The reason is that SDL_sound can be
+# compiled in a large variety of different ways which are independent of
+# platform.  SDL_sound may dynamically link against other 3rd party
+# libraries to get additional codec support, such as Ogg Vorbis, SMPEG,
+# ModPlug, MikMod, FLAC, Speex, and potentially others.  Under some
+# circumstances which I don't fully understand, there seems to be a
+# requirement that dependent libraries of libraries you use must also be
+# explicitly linked against in order to successfully compile.  SDL_sound
+# does not currently have any system in place to know how it was
+# compiled.  So this CMake module does the hard work in trying to
+# discover which 3rd party libraries are required for building (if any).
+# This module uses a brute force approach to create a test program that
+# uses SDL_sound, and then tries to build it.  If the build fails, it
+# parses the error output for known symbol names to figure out which
+# libraries are needed.
 #
-# Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable that would
-# correspond to the ./configure --prefix=$SDLDIR used in building SDL.
+# Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable that
+# would correspond to the ./configure --prefix=$SDLDIR used in building
+# SDL.
 #
 # On OSX, this will prefer the Framework version (if found) over others.
-# People will have to manually change the cache values of
-# SDL_LIBRARY to override this selectionor set the CMake environment
-# CMAKE_INCLUDE_PATH to modify the search paths.
+# People will have to manually change the cache values of SDL_LIBRARY to
+# override this selectionor set the CMake environment CMAKE_INCLUDE_PATH
+# to modify the search paths.
 
 #=============================================================================
 # Copyright 2005-2009 Kitware, Inc.