.. _add_doxygen_target:

add_doxygen_target
==================

.. cmake_function:: add_doxygen_target

   .. cmake_param:: TARGET
      :single:

      The suffix to add to the target name, default to the module name.

   .. cmake_param:: DEPENDS
      :multi:

      A list of further dependencies of the doxygen documentation.
      Might include :code:`mainpage.txt`.

   .. cmake_param:: OUTPUT
      :single:

      Name of the output target, necessary if you don't generate html.

   This macro creates a target for building (:code:`doxygen_${ProjectName}`) and installing
   (:code:`doxygen_install_${ProjectName}`) the generated doxygen documentation.
   The documentation is built during the top-level :code:`make doc` call. We have added a dependency
   that makes sure it is built before running :code:`make install`.

