root/include/doxygen.h

/* */

   1 /*
   2  * Copyright 2006-2021 the Pacemaker project contributors
   3  *
   4  * The version control history for this file may have further details.
   5  *
   6  * This source code is licensed under the GNU Lesser General Public License
   7  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
   8  */
   9 
  10 #ifndef PCMK__DOXYGEN__H
  11 #  define PCMK__DOXYGEN__H
  12 
  13 /**
  14  * \file
  15  * \brief Fake header file that contains doxygen documentation.
  16  * \author the Pacemaker project contributors
  17  *
  18  * The purpose of this file is to provide a file that can be used to create
  19  * doxygen pages.  It should contain _only_ comment blocks.
  20  *
  21  *
  22  * \defgroup core Core API
  23  * \defgroup date ISO-8601 Date/Time API
  24  * \defgroup cib Configuration API
  25  * \defgroup lrmd Executor API
  26  * \defgroup pengine Scheduler API
  27  * \defgroup fencing Fencing API
  28  * \defgroup pacemaker Pacemaker High-Level API
  29  */
  30 
  31 /**
  32  * \mainpage
  33  * Welcome to the developer documentation for The Pacemaker Project!  For more
  34  * information about Pacemaker, please visit the
  35  * <a href="https://clusterlabs.org/pacemaker/">project web site</a>.
  36  *
  37  * Here are some pointers on where to go from here.
  38  *
  39  * Using Pacemaker APIs:
  40  *  - \ref core
  41  *  - \ref date
  42  *  - \ref cib
  43  *  - \ref lrmd
  44  *  - \ref pengine
  45  *  - \ref fencing
  46  *  - \ref pacemaker
  47  *
  48  * Contributing to the Pacemaker Project:
  49  * - <a
  50  *   href="https://clusterlabs.org/pacemaker/doc/2.1/Pacemaker_Development/html/">Pacemaker Development</a>
  51  */
  52 
  53 #endif                          /* PCMK__DOXYGEN__H */

/* */