Commit 58b2d760 authored by Brad King's avatar Brad King

Modules: Format documentation to avoid over-long preformatted lines

Convert several preformatted code block literals that enumerate lists of
options or variables to use reST definition lists instead.  Manually
wrap other long lines in code blocks.
parent 54ff77dc
...@@ -20,8 +20,9 @@ ...@@ -20,8 +20,9 @@
# #
# :: # ::
# #
# cmake_expand_imported_targets(expandedLibs LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} # cmake_expand_imported_targets(expandedLibs
# CONFIGURATION "${CMAKE_TRY_COMPILE_CONFIGURATION}" ) # LIBRARIES ${CMAKE_REQUIRED_LIBRARIES}
# CONFIGURATION "${CMAKE_TRY_COMPILE_CONFIGURATION}" )
#============================================================================= #=============================================================================
......
...@@ -7,15 +7,24 @@ ...@@ -7,15 +7,24 @@
# This file is executed by cmake when invoked with --find-package. It # This file is executed by cmake when invoked with --find-package. It
# expects that the following variables are set using -D: # expects that the following variables are set using -D:
# #
# :: # ``NAME``
# # name of the package
# NAME = name of the package # ``COMPILER_ID``
# COMPILER_ID = the CMake compiler ID for which the result is, i.e. GNU/Intel/Clang/MSVC, etc. # the CMake compiler ID for which the result is,
# LANGUAGE = language for which the result will be used, i.e. C/CXX/Fortan/ASM # i.e. GNU/Intel/Clang/MSVC, etc.
# MODE = EXIST : only check for existence of the given package # ``LANGUAGE``
# COMPILE : print the flags needed for compiling an object file which uses the given package # language for which the result will be used,
# LINK : print the flags needed for linking when using the given package # i.e. C/CXX/Fortan/ASM
# QUIET = if TRUE, don't print anything # ``MODE``
# ``EXIST``
# only check for existence of the given package
# ``COMPILE``
# print the flags needed for compiling an object file which uses
# the given package
# ``LINK``
# print the flags needed for linking when using the given package
# ``QUIET``
# if TRUE, don't print anything
#============================================================================= #=============================================================================
# Copyright 2006-2011 Alexander Neundorf, <neundorf@kde.org> # Copyright 2006-2011 Alexander Neundorf, <neundorf@kde.org>
......
...@@ -15,12 +15,13 @@ ...@@ -15,12 +15,13 @@
# #
# Create a config file for a project:: # Create a config file for a project::
# #
# configure_package_config_file(<input> <output> INSTALL_DESTINATION <path> # configure_package_config_file(<input> <output>
# [PATH_VARS <var1> <var2> ... <varN>] # INSTALL_DESTINATION <path>
# [NO_SET_AND_CHECK_MACRO] # [PATH_VARS <var1> <var2> ... <varN>]
# [NO_CHECK_REQUIRED_COMPONENTS_MACRO] # [NO_SET_AND_CHECK_MACRO]
# [INSTALL_PREFIX <path>]) # [NO_CHECK_REQUIRED_COMPONENTS_MACRO]
# # [INSTALL_PREFIX <path>]
# )
# #
# ``configure_package_config_file()`` should be used instead of the plain # ``configure_package_config_file()`` should be used instead of the plain
# :command:`configure_file()` command when creating the ``<Name>Config.cmake`` # :command:`configure_file()` command when creating the ``<Name>Config.cmake``
...@@ -51,13 +52,13 @@ ...@@ -51,13 +52,13 @@
# Using ``configure_package_config_file`` helps. If used correctly, it makes # Using ``configure_package_config_file`` helps. If used correctly, it makes
# the resulting ``FooConfig.cmake`` file relocatable. Usage: # the resulting ``FooConfig.cmake`` file relocatable. Usage:
# #
# 1. write a ``FooConfig.cmake.in`` file as you are used to # 1. write a ``FooConfig.cmake.in`` file as you are used to
# 2. insert a line containing only the string ``@PACKAGE_INIT@`` # 2. insert a line containing only the string ``@PACKAGE_INIT@``
# 3. instead of ``set(FOO_DIR "@SOME_INSTALL_DIR@")``, use # 3. instead of ``set(FOO_DIR "@SOME_INSTALL_DIR@")``, use
# ``set(FOO_DIR "@PACKAGE_SOME_INSTALL_DIR@")`` (this must be after the # ``set(FOO_DIR "@PACKAGE_SOME_INSTALL_DIR@")`` (this must be after the
# ``@PACKAGE_INIT@`` line) # ``@PACKAGE_INIT@`` line)
# 4. instead of using the normal :command:`configure_file()`, use # 4. instead of using the normal :command:`configure_file()`, use
# ``configure_package_config_file()`` # ``configure_package_config_file()``
# #
# #
# #
...@@ -116,9 +117,9 @@ ...@@ -116,9 +117,9 @@
# #
# Create a version file for a project:: # Create a version file for a project::
# #
# write_basic_package_version_file(<filename> # write_basic_package_version_file(<filename>
# [VERSION <major.minor.patch>] # [VERSION <major.minor.patch>]
# COMPATIBILITY <AnyNewerVersion|SameMajorVersion|ExactVersion> ) # COMPATIBILITY <AnyNewerVersion|SameMajorVersion|ExactVersion> )
# #
# #
# Writes a file for use as ``<package>ConfigVersion.cmake`` file to # Writes a file for use as ``<package>ConfigVersion.cmake`` file to
...@@ -172,13 +173,16 @@ ...@@ -172,13 +173,16 @@
# set(SYSCONFIG_INSTALL_DIR etc/foo/ ... CACHE ) # set(SYSCONFIG_INSTALL_DIR etc/foo/ ... CACHE )
# ... # ...
# include(CMakePackageConfigHelpers) # include(CMakePackageConfigHelpers)
# configure_package_config_file(FooConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake # configure_package_config_file(FooConfig.cmake.in
# INSTALL_DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake # ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake
# PATH_VARS INCLUDE_INSTALL_DIR SYSCONFIG_INSTALL_DIR) # INSTALL_DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake
# write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake # PATH_VARS INCLUDE_INSTALL_DIR SYSCONFIG_INSTALL_DIR)
# VERSION 1.2.3 # write_basic_package_version_file(
# COMPATIBILITY SameMajorVersion ) # ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
# install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake # VERSION 1.2.3
# COMPATIBILITY SameMajorVersion )
# install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake
# ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
# DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake ) # DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake )
# #
# ``FooConfig.cmake.in``: # ``FooConfig.cmake.in``:
......
...@@ -45,7 +45,8 @@ ...@@ -45,7 +45,8 @@
# set(options OPTIONAL FAST) # set(options OPTIONAL FAST)
# set(oneValueArgs DESTINATION RENAME) # set(oneValueArgs DESTINATION RENAME)
# set(multiValueArgs TARGETS CONFIGURATIONS) # set(multiValueArgs TARGETS CONFIGURATIONS)
# cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} ) # cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}"
# "${multiValueArgs}" ${ARGN} )
# ... # ...
# #
# #
......
...@@ -15,11 +15,10 @@ ...@@ -15,11 +15,10 @@
# #
# This macro prints the values of the properties of the given targets, # This macro prints the values of the properties of the given targets,
# source files, directories, tests or cache entries. Exactly one of the # source files, directories, tests or cache entries. Exactly one of the
# scope keywords must be used. Example: # scope keywords must be used. Example::
# #
# :: # cmake_print_properties(TARGETS foo bar PROPERTIES
# # LOCATION INTERFACE_INCLUDE_DIRS)
# cmake_print_properties(TARGETS foo bar PROPERTIES LOCATION INTERFACE_INCLUDE_DIRS)
# #
# This will print the LOCATION and INTERFACE_INCLUDE_DIRS properties for # This will print the LOCATION and INTERFACE_INCLUDE_DIRS properties for
# both targets foo and bar. # both targets foo and bar.
...@@ -29,17 +28,13 @@ ...@@ -29,17 +28,13 @@
# CMAKE_PRINT_VARIABLES(var1 var2 .. varN) # CMAKE_PRINT_VARIABLES(var1 var2 .. varN)
# #
# This macro will print the name of each variable followed by its value. # This macro will print the name of each variable followed by its value.
# Example: # Example::
#
# ::
#
# cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION THIS_ONE_DOES_NOT_EXIST)
# #
# Gives: # cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION DOES_NOT_EXIST)
# #
# :: # Gives::
# #
# -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; THIS_ONE_DOES_NOT_EXIST="" # -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; DOES_NOT_EXIST=""
#============================================================================= #=============================================================================
# Copyright 2013 Alexander Neundorf, <neundorf@kde.org> # Copyright 2013 Alexander Neundorf, <neundorf@kde.org>
......
...@@ -37,7 +37,8 @@ ...@@ -37,7 +37,8 @@
# #
# :: # ::
# #
# FIXUP_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>]) # FIXUP_QT4_EXECUTABLE(<executable>
# [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>])
# #
# Copies Qt plugins, writes a Qt configuration file (if needed) and # Copies Qt plugins, writes a Qt configuration file (if needed) and
# fixes up a Qt4 executable using BundleUtilities so it is standalone # fixes up a Qt4 executable using BundleUtilities so it is standalone
...@@ -63,7 +64,8 @@ ...@@ -63,7 +64,8 @@
# #
# :: # ::
# #
# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var <plugins_dir> <component> <configurations>) # INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var
# <plugins_dir> <component> <configurations>)
# #
# Install (or copy) a resolved <plugin> to the default plugins directory # Install (or copy) a resolved <plugin> to the default plugins directory
# (or <plugins_dir>) relative to <executable> and store the result in # (or <plugins_dir>) relative to <executable> and store the result in
...@@ -77,7 +79,8 @@ ...@@ -77,7 +79,8 @@
# #
# :: # ::
# #
# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var <plugins_dir> <component>) # INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var
# <plugins_dir> <component>)
# #
# Install (or copy) an unresolved <plugin> to the default plugins # Install (or copy) an unresolved <plugin> to the default plugins
# directory (or <plugins_dir>) relative to <executable> and store the # directory (or <plugins_dir>) relative to <executable> and store the
...@@ -86,7 +89,8 @@ ...@@ -86,7 +89,8 @@
# #
# :: # ::
# #
# INSTALL_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>]) # INSTALL_QT4_EXECUTABLE(<executable>
# [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>])
# #
# Installs Qt plugins, writes a Qt configuration file (if needed) and # Installs Qt plugins, writes a Qt configuration file (if needed) and
# fixes up a Qt4 executable using BundleUtilities so it is standalone # fixes up a Qt4 executable using BundleUtilities so it is standalone
......
...@@ -55,21 +55,32 @@ ...@@ -55,21 +55,32 @@
# The WHAT option is the only mandatory option. Here you specify what # The WHAT option is the only mandatory option. Here you specify what
# information will be printed: # information will be printed:
# #
# :: # ``ALL``
# # print everything
# ALL: print everything # ``ENABLED_FEATURES``
# ENABLED_FEATURES: the list of all features which are enabled # the list of all features which are enabled
# DISABLED_FEATURES: the list of all features which are disabled # ``DISABLED_FEATURES``
# PACKAGES_FOUND: the list of all packages which have been found # the list of all features which are disabled
# PACKAGES_NOT_FOUND: the list of all packages which have not been found # ``PACKAGES_FOUND``
# OPTIONAL_PACKAGES_FOUND: only those packages which have been found which have the type OPTIONAL # the list of all packages which have been found
# OPTIONAL_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type OPTIONAL # ``PACKAGES_NOT_FOUND``
# RECOMMENDED_PACKAGES_FOUND: only those packages which have been found which have the type RECOMMENDED # the list of all packages which have not been found
# RECOMMENDED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RECOMMENDED # ``OPTIONAL_PACKAGES_FOUND``
# REQUIRED_PACKAGES_FOUND: only those packages which have been found which have the type REQUIRED # only those packages which have been found which have the type OPTIONAL
# REQUIRED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type REQUIRED # ``OPTIONAL_PACKAGES_NOT_FOUND``
# RUNTIME_PACKAGES_FOUND: only those packages which have been found which have the type RUNTIME # only those packages which have not been found which have the type OPTIONAL
# RUNTIME_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RUNTIME # ``RECOMMENDED_PACKAGES_FOUND``
# only those packages which have been found which have the type RECOMMENDED
# ``RECOMMENDED_PACKAGES_NOT_FOUND``
# only those packages which have not been found which have the type RECOMMENDED
# ``REQUIRED_PACKAGES_FOUND``
# only those packages which have been found which have the type REQUIRED
# ``REQUIRED_PACKAGES_NOT_FOUND``
# only those packages which have not been found which have the type REQUIRED
# ``RUNTIME_PACKAGES_FOUND``
# only those packages which have been found which have the type RUNTIME
# ``RUNTIME_PACKAGES_NOT_FOUND``
# only those packages which have not been found which have the type RUNTIME
# #
# With the exception of the ``ALL`` value, these values can be combined # With the exception of the ``ALL`` value, these values can be combined
# in order to customize the output. For example: # in order to customize the output. For example:
...@@ -118,10 +129,11 @@ ...@@ -118,10 +129,11 @@
# #
# :: # ::
# #
# SET_PACKAGE_PROPERTIES(<name> PROPERTIES [ URL <url> ] # SET_PACKAGE_PROPERTIES(<name> PROPERTIES
# [ DESCRIPTION <description> ] # [ URL <url> ]
# [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ] # [ DESCRIPTION <description> ]
# [ PURPOSE <purpose> ] # [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ]
# [ PURPOSE <purpose> ]
# ) # )
# #
# #
...@@ -171,26 +183,30 @@ ...@@ -171,26 +183,30 @@
# :: # ::
# #
# find_package(LibXml2) # find_package(LibXml2)
# set_package_properties(LibXml2 PROPERTIES DESCRIPTION "A XML processing library." # set_package_properties(LibXml2 PROPERTIES
# URL "http://xmlsoft.org/") # DESCRIPTION "A XML processing library."
# URL "http://xmlsoft.org/")
# #
# #
# #
# :: # ::
# #
# set_package_properties(LibXml2 PROPERTIES TYPE RECOMMENDED # set_package_properties(LibXml2 PROPERTIES
# PURPOSE "Enables HTML-import in MyWordProcessor") # TYPE RECOMMENDED
# PURPOSE "Enables HTML-import in MyWordProcessor")
# ... # ...
# set_package_properties(LibXml2 PROPERTIES TYPE OPTIONAL # set_package_properties(LibXml2 PROPERTIES
# PURPOSE "Enables odt-export in MyWordProcessor") # TYPE OPTIONAL
# PURPOSE "Enables odt-export in MyWordProcessor")
# #
# #
# #
# :: # ::
# #
# find_package(DBUS) # find_package(DBUS)
# set_package_properties(DBUS PROPERTIES TYPE RUNTIME # set_package_properties(DBUS PROPERTIES
# PURPOSE "Necessary to disable the screensaver during a presentation" ) # TYPE RUNTIME
# PURPOSE "Necessary to disable the screensaver during a presentation" )
# #
# #
# #
......
...@@ -5,18 +5,24 @@ ...@@ -5,18 +5,24 @@
# Find provider for backtrace(3). # Find provider for backtrace(3).
# #
# Checks if OS supports backtrace(3) via either libc or custom library. # Checks if OS supports backtrace(3) via either libc or custom library.
# This module defines the following variables:: # This module defines the following variables:
# #
# Backtrace_HEADER - The header file needed for backtrace(3). Cached. # ``Backtrace_HEADER``
# Could be forcibly set by user. # The header file needed for backtrace(3). Cached.
# Backtrace_INCLUDE_DIRS - The include directories needed to use backtrace(3) header. # Could be forcibly set by user.
# Backtrace_LIBRARIES - The libraries (linker flags) needed to use backtrace(3), if any. # ``Backtrace_INCLUDE_DIRS``
# Backtrace_FOUND - Is set if and only if backtrace(3) support detected. # The include directories needed to use backtrace(3) header.
# ``Backtrace_LIBRARIES``
# The libraries (linker flags) needed to use backtrace(3), if any.
# ``Backtrace_FOUND``
# Is set if and only if backtrace(3) support detected.
# #
# The following cache variables are also available to set or use:: # The following cache variables are also available to set or use:
# #
# Backtrace_LIBRARY - The external library providing backtrace, if any. # ``Backtrace_LIBRARY``
# Backtrace_INCLUDE_DIR - The directory holding the backtrace(3) header. # The external library providing backtrace, if any.
# ``Backtrace_INCLUDE_DIR``
# The directory holding the backtrace(3) header.
# #
# Typical usage is to generate of header file using configure_file() with the # Typical usage is to generate of header file using configure_file() with the
# contents like the following:: # contents like the following::
......
...@@ -8,29 +8,29 @@ ...@@ -8,29 +8,29 @@
# #
# This module defines the following variables: # This module defines the following variables:
# #
# :: # ``KDE3_DEFINITIONS``
# # compiler definitions required for compiling KDE software
# KDE3_DEFINITIONS - compiler definitions required for compiling KDE software # ``KDE3_INCLUDE_DIR``
# KDE3_INCLUDE_DIR - the KDE include directory # the KDE include directory
# KDE3_INCLUDE_DIRS - the KDE and the Qt include directory, for use with include_directories() # ``KDE3_INCLUDE_DIRS``
# KDE3_LIB_DIR - the directory where the KDE libraries are installed, for use with link_directories() # the KDE and the Qt include directory, for use with include_directories()
# QT_AND_KDECORE_LIBS - this contains both the Qt and the kdecore library # ``KDE3_LIB_DIR``
# KDE3_DCOPIDL_EXECUTABLE - the dcopidl executable # the directory where the KDE libraries are installed, for use with link_directories()
# KDE3_DCOPIDL2CPP_EXECUTABLE - the dcopidl2cpp executable # ``QT_AND_KDECORE_LIBS``
# KDE3_KCFGC_EXECUTABLE - the kconfig_compiler executable # this contains both the Qt and the kdecore library
# KDE3_FOUND - set to TRUE if all of the above has been found # ``KDE3_DCOPIDL_EXECUTABLE``
# # the dcopidl executable
# # ``KDE3_DCOPIDL2CPP_EXECUTABLE``
# the dcopidl2cpp executable
# ``KDE3_KCFGC_EXECUTABLE``
# the kconfig_compiler executable
# ``KDE3_FOUND``
# set to TRUE if all of the above has been found
# #
# The following user adjustable options are provided: # The following user adjustable options are provided:
# #
# :: # ``KDE3_BUILD_TESTS``
# # enable this to build KDE testcases
# KDE3_BUILD_TESTS - enable this to build KDE testcases
#
#
#
#
# #
# It also adds the following macros (from KDE3Macros.cmake) SRCS_VAR is # It also adds the following macros (from KDE3Macros.cmake) SRCS_VAR is
# always the variable which contains the list of source files for your # always the variable which contains the list of source files for your
...@@ -101,7 +101,8 @@ ...@@ -101,7 +101,8 @@
# #
# :: # ::
# #
# Currently identical to add_executable(), may provide some advanced features in the future. # Currently identical to add_executable(), may provide some advanced
# features in the future.
# #
# #
# #
...@@ -110,7 +111,8 @@ ...@@ -110,7 +111,8 @@
# :: # ::
# #
# Create a KDE plugin (KPart, kioslave, etc.) from the given source files. # Create a KDE plugin (KPart, kioslave, etc.) from the given source files.
# If WITH_PREFIX is given, the resulting plugin will have the prefix "lib", otherwise it won't. # If WITH_PREFIX is given, the resulting plugin will have the prefix "lib",
# otherwise it won't.
# It creates and installs an appropriate libtool la-file. # It creates and installs an appropriate libtool la-file.
# #
# #
...@@ -120,7 +122,8 @@ ...@@ -120,7 +122,8 @@
# :: # ::
# #
# Create a KDE application in the form of a module loadable via kdeinit. # Create a KDE application in the form of a module loadable via kdeinit.
# A library named kdeinit_<name> will be created and a small executable which links to it. # A library named kdeinit_<name> will be created and a small executable
# which links to it.
# #
# #
# #
......
...@@ -40,13 +40,14 @@ ...@@ -40,13 +40,14 @@
# OSG and it's various components. CMAKE_PREFIX_PATH can also be used # OSG and it's various components. CMAKE_PREFIX_PATH can also be used
# for this (see find_library() CMake documentation). # for this (see find_library() CMake documentation).
# #
# :: # ``<MODULE>_DIR``
# # (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file)
# <MODULE>_DIR (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file) # ``OSG_DIR``
# OSG_DIR # ..
# OSGDIR # ``OSGDIR``
# OSG_ROOT # ..
# # ``OSG_ROOT``
# ..
# #
# #
# [CMake 2.8.10]: The CMake variable OSG_DIR can now be used as well to # [CMake 2.8.10]: The CMake variable OSG_DIR can now be used as well to
......
...@@ -10,19 +10,22 @@ ...@@ -10,19 +10,22 @@
# #
# It defines the following variables # It defines the following variables
# #
# :: # ``PNG_INCLUDE_DIRS``
# # where to find png.h, etc.
# PNG_INCLUDE_DIRS, where to find png.h, etc. # ``PNG_LIBRARIES``
# PNG_LIBRARIES, the libraries to link against to use PNG. # the libraries to link against to use PNG.
# PNG_DEFINITIONS - You should add_definitons(${PNG_DEFINITIONS}) before compiling code that includes png library files. # ``PNG_DEFINITIONS``
# PNG_FOUND, If false, do not try to use PNG. # You should add_definitons(${PNG_DEFINITIONS}) before compiling code
# PNG_VERSION_STRING - the version of the PNG library found (since CMake 2.8.8) # that includes png library files.
# ``PNG_FOUND``
# If false, do not try to use PNG.
# ``PNG_VERSION_STRING``
# the version of the PNG library found (since CMake 2.8.8)
# #
# Also defined, but not for general use are # Also defined, but not for general use are
# #
# :: # ``PNG_LIBRARY``
# # where to find the PNG library.
# PNG_LIBRARY, where to find the PNG library.
# #
# For backward compatiblity the variable PNG_INCLUDE_DIR is also set. # For backward compatiblity the variable PNG_INCLUDE_DIR is also set.
# It has the same value as PNG_INCLUDE_DIRS. # It has the same value as PNG_INCLUDE_DIRS.
......
...@@ -20,7 +20,8 @@ ...@@ -20,7 +20,8 @@
# #
# :: # ::
# #
# FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name> (DEFAULT_MSG|"Custom failure message") <var1>...<varN> ) # FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name>
# (DEFAULT_MSG|"Custom failure message") <var1>...<varN> )
# #
# If the variables <var1> to <varN> are all valid, then # If the variables <var1> to <varN> are all valid, then
# <UPPERCASED_NAME>_FOUND will be set to TRUE. If DEFAULT_MSG is given # <UPPERCASED_NAME>_FOUND will be set to TRUE. If DEFAULT_MSG is given
...@@ -32,14 +33,13 @@ ...@@ -32,14 +33,13 @@
# #
# :: # ::
# #
# FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME [FOUND_VAR <resultVar>] # FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME
# [REQUIRED_VARS <var1>...<varN>] # [FOUND_VAR <resultVar>]
# [VERSION_VAR <versionvar>] # [REQUIRED_VARS <var1>...<varN>]
# [HANDLE_COMPONENTS] # [VERSION_VAR <versionvar>]
# [CONFIG_MODE] # [HANDLE_COMPONENTS]
# [FAIL_MESSAGE "Custom failure message"] ) # [CONFIG_MODE]
# # [FAIL_MESSAGE "Custom failure message"] )
#
# #
# In this mode, the name of the result-variable can be set either to # In this mode, the name of the result-variable can be set either to
# either <UPPERCASED_NAME>_FOUND or <OriginalCase_Name>_FOUND using the # either <UPPERCASED_NAME>_FOUND or <OriginalCase_Name>_FOUND using the
...@@ -75,7 +75,8 @@ ...@@ -75,7 +75,8 @@
# #