diff options
| author | Alex Merry <alex.merry@kde.org> | 2014-04-10 21:38:09 +0100 |
|---|---|---|
| committer | Alex Merry <alex.merry@kde.org> | 2014-04-11 21:12:58 +0100 |
| commit | c20d22c951e61a06701f6c2201add7c11915e7c5 (patch) | |
| tree | a8f375967eaeeceffac6da5098700b4563bf2306 /modules/ECMFindModuleHelpers.cmake | |
| parent | ddd33b850bb519174511a34eeda40af69a1f7144 (diff) | |
| download | extra-cmake-modules-c20d22c951e61a06701f6c2201add7c11915e7c5.tar.gz extra-cmake-modules-c20d22c951e61a06701f6c2201add7c11915e7c5.tar.bz2 | |
Add documentation generation using Sphinx
This is deliberately modelled very closely on CMake's documentation
system. It's a hefty patch, because it involved changing all the
documentation to be in reStructuredText format. I also cleaned up the
copyright/license statements at the same time.
Note that the find modules contain the full license, due to the fact
that ecm_use_find_module() copies them out of the ECM distribution.
Diffstat (limited to 'modules/ECMFindModuleHelpers.cmake')
| -rw-r--r-- | modules/ECMFindModuleHelpers.cmake | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/modules/ECMFindModuleHelpers.cmake b/modules/ECMFindModuleHelpers.cmake index e38fcaf2..15df9ef0 100644 --- a/modules/ECMFindModuleHelpers.cmake +++ b/modules/ECMFindModuleHelpers.cmake @@ -1,13 +1,23 @@ -# Helper macros for find modules +#.rst: +# ECMFindModuleHelpers +# -------------------- +# +# Helper macros for find modules: ecm_find_package_version_check(), +# ecm_find_package_parse_components() and +# ecm_find_package_handle_library_components(). +# +# :: # # ecm_find_package_version_check(<name>) # # Prints warnings if the CMake version or the project's required CMake version # is older than that required by extra-cmake-modules. # +# :: +# # ecm_find_package_parse_components(<name> # RESULT_VAR <variable> -# KNOWN_COMPONENTS <component> [<component>]* +# KNOWN_COMPONENTS <component1> [<component2> [...]] # [SKIP_DEPENDENCY_HANDLING]) # # This macro will populate <variable> with a list of components found in @@ -24,8 +34,10 @@ # If <component> is listed in <name>_FIND_COMPONENTS, then all its (transitive) # dependencies will also be added to <variable>. # +# :: +# # ecm_find_package_handle_library_components(<name> -# COMPONENTS <component> [<component>]* +# COMPONENTS <component> [<component> [...]] # [SKIP_DEPENDENCY_HANDLING]) # [SKIP_PKG_CONFIG]) # @@ -65,6 +77,9 @@ # the component that is searched for first (note that components are searched # for in the order they are passed to the macro). +# FIXME: we should actually set proper traditional variables, because it can +# be convenient to use them in the link interface of exported libraries + #============================================================================= # Copyright 2014 Alex Merry <alex.merry@kde.org> # |