Write CMake API documentation for dune-istl

cmake/modules/AddARPACKPPFlags.cmake

+# Defines the functions to use ARPACKPP
 #
-# Module providing convenience methods for compile binaries with ARPACK++ support.
+# .. cmake_function:: add_dune_arpackpp_flags
 #
-# Provides the following functions:
+#    .. cmake_param:: targets
+#       :positional:
+#       :single:
+#       :required:
 #
-# add_dune_arpackpp_flags(target1 target2 ...)
-#
-# adds ARPACK++ flags to the targets for compilation and linking
+#       A list of targets to use ARPACKPP with.
 #
+
 function(add_dune_arpackpp_flags _targets)
   if(ARPACKPP_FOUND)
     foreach(_target ${_targets})

cmake/modules/AddSuperLUFlags.cmake

+# Defines the functions to use SuperLU
 #
-# Module providing convenience methods for compile binaries with SuperLU support.
+# .. cmake_function:: add_dune_superlu_flags
 #
-# Provides the following functions:
+#    .. cmake_param:: targets
+#       :positional:
+#       :single:
+#       :required:
 #
-# add_dune_superlu_flags(target1 target2 ...)
-#
-# adds SuperLU flags to the targets for compilation and linking
+#       A list of targets to use SuperLU with.
 #
+
 function(add_dune_superlu_flags)
   if(SUPERLU_FOUND)
     cmake_parse_arguments(_add_superlu "OBJECT" "" "" ${ARGN})

cmake/modules/DuneIstlMacros.cmake

+# .. cmake_module::
+#
+#    This modules content is executed whenever a module required or suggests dune-istl!
+#
+
 find_package(METIS)
 find_package(ParMETIS)
 include(AddParMETISFlags)

cmake/modules/FindARPACK.cmake

+# .. cmake_module::
 #
-# Module that checks whether ARPACK is available and usable.
+#    Module that checks whether ARPACK is available and usable.
 #
-# Variables used by this module which you may want to set:
-# ARPACK_ROOT           Path list to search for ARPACK.
+#    Variables used by this module which you may want to set:
 #
-# Sets the following variables:
-# ARPACK_FOUND          True if ARPACK available.
-# ARPACK_LIBRARIES      Link against these libraries to use ARPACK.
+#    :ref:`ARPACK_ROOT`
+#       Path list to search for ARPACK.
+#
+#    Sets the following variables:
+#
+#    :code:`ARPACK_FOUND`
+#       True if ARPACK available.
+#
+#    :code:`ARPACK_LIBRARIES`
+#       Link against these libraries to use ARPACK.
+#
+# .. cmake_variable:: ARPACK_ROOT
+#
+#    You may set this variable to have :ref:`FindARPACK` look
+#    for the ARPACK package in the given path before inspecting
+#    system paths.
 #
 
 # check for Fortran support which is required by ARPACK

cmake/modules/FindARPACKPP.cmake

+# .. cmake_module::
 #
-# Module that checks whether ARPACK++ is available and usable.
+#    Module that checks whether ARPACK++ is available and usable.
 #
-# Variables used by this module which you may want to set:
-# ARPACKPP_ROOT           Path list to search for ARPACK++.
+#    Variables used by this module which you may want to set:
 #
-# Sets the following variables:
-# ARPACKPP_FOUND          True if ARPACK++ available.
-# ARPACKPP_INCLUDE_DIRS   Path to the ARPACK++ include directories.
-# ARPACKPP_LIBRARIES      Link against these libraries to use ARPACK++.
+#    :ref:`ARPACKPP_ROOT`
+#       Path list to search for ARPACK++.
+#
+#    Sets the following variables:
+#
+#    :code:`ARPACKPP_FOUND`
+#       True if ARPACK++ available.
+#
+#    :code:`ARPACKPP_INCLUDE_DIRS`
+#       Path to the ARPACK++ include directories.
+#
+#    :code:`ARPACKPP_LIBRARIES`
+#       Link against these libraries to use ARPACK++.
+#
+# .. cmake_variable:: ARPACKPP_ROOT
+#
+#    You may set this variable to have :ref:`FindARPACKPP` look
+#    for the ARPACKPP package in the given path before inspecting
+#    system paths.
 #
 
 # find ARPACK which is required by ARPACK++

cmake/modules/FindSuperLU.cmake

-
+# .. cmake_module::
+#
+#    Module that checks whether SuperLU is available and usable.
+#    SuperLU must be a version released after the year 2005.
+#
+#    Variables used by this module which you may want to set:
+#
+#    :ref:`SUPERLU_ROOT`
+#       Path list to search for SuperLU
+#
+#    Sets the follwing variables:
+#
+#    :code:`SUPERLU_FOUND`
+#       True if SuperLU available and usable.
+#
+#    :code:`SUPERLU_MIN_VERSION_4_3`
+#       True if SuperLU version >= 4.3.
+#
+#    :code:`SUPERLU_WITH_VERSION`
+#       Human readable string containing version information.
 #
-# Module that checks whether SuperLU is available and usable.
-# SuperLU must be a version released after the year 2005.
+#    :code:`SUPERLU_INCLUDE_DIRS`
+#       Path to the SuperLU include dirs.
 #
-# Variables used by this module which you may want to set:
-# SUPERLU_ROOT         Path list to search for SuperLU
+#    :code:`SUPERLU_LIBRARIES`
+#       Name to the SuperLU library.
 #
-# Sets the follwing variable:
+# .. cmake_variable:: SUPERLU_ROOT
 #
-# SUPERLU_FOUND           True if SuperLU available and usable.
-# SUPERLU_MIN_VERSION_4_3 True if SuperLU version >= 4.3.
-# SUPERLU_WITH_VERSION    Human readable string containing version information.
-# SUPERLU_INCLUDE_DIRS    Path to the SuperLU include dirs.
-# SUPERLU_LIBRARIES       Name to the SuperLU library.
+#    You may set this variable to have :ref:`FindSuperLU` look
+#    for the SuperLU package in the given path before inspecting
+#    system paths.
 #
 
 # look for BLAS