More doc typo fixes

[fontconfig.git] / doc / fcinit.fncs

diff --git a/doc/fcinit.fncs b/doc/fcinit.fncs
index bdf83fd86cbdf89283a1bb441bcfde97103dcc8e..014af0deaebf33bdeae3435eb52d8810bd9a211c 100644 (file)
--- a/doc/fcinit.fncs
+++ b/doc/fcinit.fncs
@@ -1,21 +1,21 @@
 /*
- * $Id$
+ * fontconfig/doc/fcinit.fncs
  *
- * Copyright © 2003 Keith Packard
+ * Copyright © 2003 Keith Packard
  *
  * Permission to use, copy, modify, distribute, and sell this software and its
  * documentation for any purpose is hereby granted without fee, provided that
  * the above copyright notice appear in all copies and that both that
  * copyright notice and this permission notice appear in supporting
- * documentation, and that the name of Keith Packard not be used in
+ * documentation, and that the name of the author(s) not be used in
  * advertising or publicity pertaining to distribution of the software without
- * specific, written prior permission.  Keith Packard makes no
+ * specific, written prior permission.  The authors make no
  * representations about the suitability of this software for any purpose.  It
  * is provided "as is" without express or implied warranty.
  *
- * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+ * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
- * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+ * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
@@ -50,6 +50,17 @@ process succeeded or not.  If the default configuration has already
 been loaded, this routine does nothing and returns FcTrue.
 @@
 
+@RET@          void
+@FUNC@         FcFini
+@TYPE1@                void
+@PURPOSE@      finalize fontconfig library
+@DESC@
+Frees all data structures allocated by previous calls to fontconfig
+functions. Fontconfig returns to an uninitialized state, requiring a
+new call to one of the FcInit functions before any other fontconfig
+function may be called.
+@@
+
 @RET@           int       
 @FUNC@          FcGetVersion 
 @TYPE1@                void
@@ -64,7 +75,9 @@ Returns the version number of the library.
 @PURPOSE@      re-initialize library
 @DESC@
 Forces the default configuration file to be reloaded and resets the default
-configuration.
+configuration. Returns FcFalse if the configuration cannot be reloaded (due
+to configuration file errors, allocation failures or other issues) and leaves the
+existing configuration unchanged. Otherwise returns FcTrue.
 @@
 
 @RET@           FcBool       
@@ -74,5 +87,6 @@ configuration.
 @DESC@
 Checks the rescan interval in the default configuration, checking the
 configuration if the interval has passed and reloading the configuration if
-when any changes are detected.
+when any changes are detected. Returns FcFalse if the configuration cannot
+be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.
 @@