doxygen/RunDoxygen.cmake.cmakein

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2013, by the GROMACS development team, led by
   5 # David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6 # others, as listed in the AUTHORS file in the top-level source
   7 # directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 set(DOXYGEN_EXECUTABLE   @DOXYGEN_EXECUTABLE@)
  36 set(DOXYGEN_MSCGEN_FOUND @DOXYGEN_MSCGEN_FOUND@)
  37
  38 message("Running Doxygen...")
  39 # The standard output shows a lot of progress information, but obscures errors
  40 # that may appear.  CMake-introduced buffering also makes it appear sluggish,
  41 # so disable it.
  42 execute_process(COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile-${DOCTYPE}
  43                 OUTPUT_QUIET)
  44 file(READ doxygen-${DOCTYPE}.log DOXYGEN_WARNINGS)
  45 if (DOXYGEN_WARNINGS)
  46     string(STRIP "${DOXYGEN_WARNINGS}" STRIPPED_WARNINGS)
  47     message("The following warnings were produced by Doxygen:")
  48     message("${STRIPPED_WARNINGS}")
  49 endif ()
  50 # Remove some useless/hard-to-suppress warnings from the file to avoid Jenkins
  51 # complaining.
  52 string(REGEX REPLACE
  53        "warning:[^\n]*Consider increasing DOT_GRAPH_MAX_NODES.\n" ""
  54        DOXYGEN_WARNINGS "${DOXYGEN_WARNINGS}")
  55 file(WRITE doxygen-${DOCTYPE}.log "${DOXYGEN_WARNINGS}")
  56 if (NOT DOXYGEN_MSCGEN_FOUND)
  57     message("NOTE: mscgen was not available. "
  58             "Please install it to produce graphs in the documentation.")
  59 endif ()