Add documentation

cmake/common/utils.cmake

@@ -70,6 +70,16 @@ endfunction()
 # }}}
 # find_package_impl {{{
 
+# Uses PkgConfig to search for pkg_config_name
+#
+# Defines the following variables:
+# ${find_pkg_name}_FOUND - True if the package has been found
+# ${find_pkg_name}_INCLUDE_DIR - <...>_INCLUDE_DIRS exported by pkg_check_modules
+# ${find_pkg_name}_INCLUDE_DIRS - Same as ${find_pkg_name}_INCLUDE_DIR
+# ${find_pkg_name}_LIBRARY - <...>_LIBRARIES exported by pkg_check_modules
+# ${find_pkg_name}_LIBRARIES - Same as ${find_pkg_name}_LIBRARY
+# ${find_pkg_name}_VERSION - <...>_VERSION exported by pkg_check_modules
+#
 macro(find_package_impl pkg_config_name find_pkg_name header_to_find)
   find_package(PkgConfig REQUIRED)
   include(FindPackageHandleStandardArgs)

cmake/modules/FindCairoFC.cmake

@@ -1,3 +1,12 @@
+# This module defines an imported target `Cairo::CairoFC` if cairo-fc is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# CairoFC_FOUND
+# CairoFC_INCLUDE_DIR
+# CairoFC_INCLUDE_DIRS
+# CairoFC_LIBRARY
+# CairoFC_LIBRARIES
+# CairoFC_VERSION
 find_package_impl("cairo-fc" "CairoFC" "")
 
 if(CairoFC_FOUND AND NOT TARGET Cairo::CairoFC)

cmake/modules/FindLibInotify.cmake

@@ -1,3 +1,12 @@
+# This module defines an imported target `LibInotify::LibInotify` if libinotify is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# LibInotify_FOUND
+# LibInotify_INCLUDE_DIR
+# LibInotify_INCLUDE_DIRS
+# LibInotify_LIBRARY
+# LibInotify_LIBRARIES
+# LibInotify_VERSION
 find_package_impl("libinotify" "LibInotify" "")
 
 if(LibInotify_FOUND AND NOT TARGET LibInotify::LibInotify)

cmake/modules/FindLibMPDClient.cmake

@@ -1,3 +1,12 @@
+# This module defines an imported target `LibMPDClient::LibMPDClient` if libmpdclient is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# LibMPDClient_FOUND
+# LibMPDClient_INCLUDE_DIR
+# LibMPDClient_INCLUDE_DIRS
+# LibMPDClient_LIBRARY
+# LibMPDClient_LIBRARIES
+# LibMPDClient_VERSION
 find_package_impl("libmpdclient" "LibMPDClient" "mpd/player.h")
 
 if(LibMPDClient_FOUND AND NOT TARGET LibMPDClient::LibMPDClient)

cmake/modules/FindLibNlGenl3.cmake

@@ -1,3 +1,12 @@
+# This module defines an imported target `LibNlGenl3::LibNlGenl3` if libnl-genl-3.0 is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# LibNlGenl3_FOUND
+# LibNlGenl3_INCLUDE_DIR
+# LibNlGenl3_INCLUDE_DIRS
+# LibNlGenl3_LIBRARY
+# LibNlGenl3_LIBRARIES
+# LibNlGenl3_VERSION
 find_package_impl("libnl-genl-3.0" "LibNlGenl3" "")
 
 if(LibNlGenl3_FOUND AND NOT TARGET LibNlGenl3::LibNlGenl3)

cmake/modules/FindLibPulse.cmake

@@ -1,3 +1,12 @@
+# This module defines an imported target `LibPulse::LibPulse` if libpulse is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# LibPulse_FOUND
+# LibPulse_INCLUDE_DIR
+# LibPulse_INCLUDE_DIRS
+# LibPulse_LIBRARY
+# LibPulse_LIBRARIES
+# LibPulse_VERSION
 find_package_impl("libpulse" "LibPulse" "pulse/version.h")
 
 if(LibPulse_FOUND AND NOT TARGET LibPulse::LibPulse)

cmake/modules/FindXcb.cmake

@@ -1,3 +1,18 @@
+# Loads multiple XCB components
+# Version checks will be made against all requested components
+#
+# For each component ${comp} it does the following:
+#
+# Defines an imported target `Xcb::${comp}` if xcb-${comp} is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# Xcb_${comp}_FOUND
+# Xcb_${comp}_INCLUDE_DIR
+# Xcb_${comp}_INCLUDE_DIRS
+# Xcb_${comp}_LIBRARY
+# Xcb_${comp}_LIBRARIES
+# Xcb_${comp}_VERSION
+
 # This script only supports the following components of XCB
 set(XCB_known_components
   XCB