root/include/doxygen.h

/* */

   1 /* doxygen.h */
   2 
   3 /*
   4  * Copyright (C) 2006 - 2012
   5  *     Andrew Beekhof <andrew@beekhof.net>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU Lesser General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  */
  21 
  22 #ifndef DOXYGEN__H
  23 #  define DOXYGEN__H
  24 
  25 /**
  26  * \file
  27  * \brief Fake header file that contains doxygen documentation.
  28  * \author Andrew Beekhof <andrew@beekhof.net>
  29  *
  30  * The purpose of this file is to provide a file that can be used to create
  31  * doxygen pages.  It should contain _only_ comment blocks.
  32  *
  33  *
  34  * \defgroup core Core API
  35  * \defgroup date ISO-8601 Date/Time API
  36  * \defgroup cib Configuration API
  37  * \defgroup lrmd Local Resource Manager API
  38  * \defgroup pengine Policy Engine API
  39  * \defgroup fencing Fencing API
  40  */
  41 
  42 /**
  43  * \mainpage
  44  * Welcome to the developer documentation for The Pacemaker Project!  For more
  45  * information about Pacemaker, please visit the
  46  * <a href="http://clusterlabs.org/">project web site</a>.
  47  *
  48  * Here are some pointers on where to go from here.
  49  *
  50  * Using Pacemaker APIs:
  51  *  - \ref core
  52  *  - \ref date
  53  *  - \ref cib
  54  *  - \ref lrmd
  55  *  - \ref pengine
  56  *  - \ref fencing
  57  *
  58  * Contributing to the Pacemaker Project:
  59  * - <a href="http://clusterlabs.org/doc/en-US/Pacemaker/1.1-pcs/html-single/Pacemaker_Development/">Pacemaker Development</a>
  60  */
  61 
  62 #endif                          /* DOXYGEN__H */

/* */