docs/devel/reference.sgml

   1   <part id="evolution-api-reference">
   2     <title>&Evolution; API Reference</title>
   3
   4     <partintro>
   5       <para>
   6         This part presents the class and function reference for the
   7         different libraries and interfaces that &Evolution; provides.
   8         Classes are described together with their methods; individual
   9         functions are grouped by functional group.
  10       </para>
  11
  12       <para>
  13         &Evolution; provides two kinds of interfaces, public and
  14         private.  The public interfaces are those designed to be used
  15         from third-party applications or components; if you wanted to
  16         write an application that uses &Evolution;'s data repositories
  17         to display data in a particular way, you would use the public
  18         interfaces.  The private interfaces are those used inside
  19         &Evolution; itself; these are generally not interesting unless
  20         you intend to make modifications to the &Evolution; code base.
  21       </para>
  22
  23       <para>
  24         While the public and private interfaces are described in
  25         separate reference sections, we have decided to put them
  26         together in the same book, this guide, because we want to
  27         encourage you to regard &Evolution; as something more than a
  28         black box that stores and dispatches personal information.  We
  29         want you to make modifications to the &Evolution; core if
  30         these would allow you to present or store your data in better
  31         ways.  &Evolution; is free software; we want you to learn from
  32         its design and implementation details so that you can make it
  33         even better for the whole world to use.
  34       </para>
  35     </partintro>
  36
  37     &calendar-public-reference;
  38     <!-- &importer-public-reference; -->
  39     <!-- &evolution-services-public-reference; -->
  40     <!-- &importer-private-reference; -->
  41     <!-- &evolution-services-private-reference; -->
  42   </part>
  43
  44 <!--
  45 Local variables:
  46 mode: sgml
  47 sgml-parent-document: ("evolution-devel-guide.sgml" "book" "book" "")
  48 End:
  49 -->