Commits

aidan  committed b459a20

Spelling & grammar fix for fontconfig.

  • Participants
  • Parent commits 5e9f5c7

Comments (0)

Files changed (2)

+2005-05-05  Aidan Kehoe  <kehoea@parhasard.net>
+
+	* texi/xemacs/fontconfig.texi (Top):
+	* texi/xemacs/fontconfig.texi (Font Configuration):
+	* texi/xemacs/fontconfig.texi (Constants):
+	* texi/xemacs/fontconfig.texi (FcMatrix):
+	* texi/xemacs/fontconfig.texi (FcCharSet):
+	* texi/xemacs/fontconfig.texi (FcLangSet):
+	* texi/xemacs/fontconfig.texi (Initialization):
+	* texi/xemacs/fontconfig.texi (FcAtomic):
+	* texi/xemacs/fontconfig.texi (FcStrSet and FcStrList):
+	Spelling and grammar fixes; the residue of an attempt to document
+	FcLangSetCompare in a new comment. 
+	
 2005-02-02  Stephen J. Turnbull  <stephen@xemacs.org>
 
 	* texi/xemacs/xemacs-devguide.texi: New file.

File texi/xemacs/fontconfig.texi

 about the suitability of this Documentation for any purpose.  It is
 provided "as is" without express or implied warranty.
 
-THE AUTHORS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS DOCUMENTATION,
+THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS DOCUMENTATION,
 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 changing the running configuration is to add fonts and directories to the
 list of application-provided font files.  
 
-The intent is to make font configurations relatively static, and shared by
+The intent is to make font configuration relatively static, and shared by
 as many applications as possible.  It is hoped that this will lead to more
 stable font selection when passing names from one application to another.
 XML was chosen as a configuration file format because it provides a format
 choose appropriate functionality from the library instead of forcing them to
 choose between this library and a private configuration mechanism.  The hope
 is that this will ensure that configuration of fonts for all applications
-can be centralized in one place.  Centralizing font configuration will make
+can be centralized in one place.  Centralizing font configuration will
 simplify and regularize font installation and customization.
 
 @node Font Properties, Font Matching, Font Configuration, Overview
 @code{FC_REVISION}, or use the combined constant @code{FC_VERSION}, defined
 as @code{FC_MAJOR*10000 + FC_MINOR*100 + FC_REVISION}.
 
-The cache version (format of @file{font.cache-1}?) is given by
-@code{FC_CACHE_VERSION}, and is a string, not an integer.  The cache file
+@c fontconfig.h details what FC_CACHE_VERSION is, exactly. 
+The cache version is given by @code{FC_CACHE_VERSION}, and is a string, not
+an integer.  This is normally appended to the end of the cache file name, so
+multiple versions of fontconfig can peacefully co-exist.  The cache file
 names are defined as @code{FC_DIR_CACHE_FILE} and @code{FC_USER_CACHE_FILE}.
 
 The Boolean constants are @code{FcFalse} (0) and @code{FcTrue} (1).
 @deftypefun void FcMatrixMultiply (FcMatrix *@var{result}, const FcMatrix *@var{a}, const FcMatrix *var{b})
 
 Multiplies 'a' and 'b' together, placing the result in 'result'.  'result'
-may refer to the sam matrix as either 'a' or 'b'.
+may refer to the same matrix as either 'a' or 'b'.
 @end deftypefun
 
 @deftypefun void FcMatrixRotate (FcMatrix *m, double c, double s)
 this may be visible to applications as the result of FcCharSetCopy may
 return its argument, and that CharSet may remain unmodifiable.
 
+When represented as a string, an FcCharSet is not a pure bitmap; octet
+values are limited such that FcCharSet objects, when printed, are valid
+ASCII characters.
+
 @deftypefun {FcCharSet *} FcCharSetCreate (void)
 
 Creates an empty FcCharSet object.
 @end deftypefun
 
 @deftypefun FcLangResult FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
+@c The actual code isn't remotely clear either. And I suspect it's buggy; 
+@c cf this in FcLangSetEqual: 
+@c
+@c  for (i = 0; i < NUM_LANG_SET_MAP; i++)
+@c  {
+@c     if (lsa->map[i] != lsb->map[i])
+@c          return FcFalse;
+@c  }
+@c
+@c vs. this in FcLangSetCompare: 
+@c
+@c  for (i = 0; i < NUM_LANG_SET_MAP; i++)
+@c      if (lsa->map[i] & lsb->map[i])
+@c          return FcLangEqual;
 
 #### Document me.
 @end deftypefun
 @deftypefun void FcConfigDestroy (FcConfig *config)
 
 Destroys a configuration and any data associated with it.  Note that calling
-this function with the return from FcConfigGetCurrent will place the library
-in an indeterminate state.
+this function with the return value from FcConfigGetCurrent will place the
+library in an indeterminate state.
 @end deftypefun
 
 @deftypefun FcBool FcConfigSetCurrent (FcConfig *config)
 @deftypefun FcAtomic * FcAtomicCreate (const FcChar8   *file)
 
 Creates a data structure containing data needed to control access to 'file'.
-Writing is done to a separate file.  Once that file is complete, the original
-configuration file is atomically replaced so that reading process always see
-a consistent and complete file without the need to lock for reading.
+Writing is done to a separate file.  Once that file is complete, the
+original configuration file is atomically replaced so that reading processes
+always see a consistent and complete file without the need to lock for
+reading.
 @end deftypefun
 
 @deftypefun FcBool FcAtomicLock (FcAtomic *atomic)
 
 @deftypefun FcBool FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s)
 
-Adds a copy 's' to 'set', The copy is created with FcStrCopyFilename
+Adds a copy of 's' to 'set', The copy is created with FcStrCopyFilename
 so that leading '~' values are replaced with the value of the HOME
 environment variable.
 @end deftypefun