service/protocol-plugin/lib/cpluff/libcpluff/docsrc/mainpage.dox

   1 /*-------------------------------------------------------------------------
   2  * C-Pluff, a plug-in framework for C
   3  * Copyright 2007 Johannes Lehtinen
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included
  13  * in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  *-----------------------------------------------------------------------*/
  23
  24 /**
  25  * @mainpage
  26  *
  27  * This is reference documentation for the
  28  * <a href="http://www.c-pluff.org/">C-Pluff</a> C API.
  29  * C-Pluff is a plug-in framework for C programs.
  30  * It has been strongly inspired by the Java plug-in framework in
  31  * <a href="http://www.eclipse.org/">Eclipse</a>. C-Pluff focuses on
  32  * providing core services for plug-in interaction and plug-in
  33  * management. It aims to be platform neutral and supports dynamic changes to
  34  * plug-in configuration without stopping the whole application or framework.
  35  * It does not yet provide special facilities for distribution such as
  36  * signed plug-in packages or remote plug-in repositories but it is
  37  * possible to build such features on top of the current framework.
  38  *
  39  * Here are links to main topics.
  40  *
  41  * - @ref architecture "Plug-in architecture"
  42  * - @ref cMainProgram "Main program"
  43  * - @ref plugin "Plug-in"
  44  *
  45  * - <a class="el" href="modules.html">API elements</a>
  46  * - <a class="el" href="files.html">Header files</a>
  47  *
  48  * For a "quick start guide" in developing C-Pluff based applications,
  49  * see the example in the examples directory of the source distribution.
  50  *
  51  * The latest version of the framework implementation
  52  * and documentation is available at
  53  * <a href="http://www.c-pluff.org/">C-Pluff web site</a>.
  54  *
  55  * This documentation has been generated from the C-Pluff source code
  56  * using <a href="http://www.doxygen.org">Doxygen</a>.
  57  */