Spelling errors in documentation. (bug 10879).

[fontconfig.git] / doc / fcstring.fncs

diff --git a/doc/fcstring.fncs b/doc/fcstring.fncs
index 56254f9e11441af9dae2d5c4f896f3a9f5c50217..bac5444bef284c8d82e6fd59ad8679041f0dcfe0 100644 (file)
--- a/doc/fcstring.fncs
+++ b/doc/fcstring.fncs
@@ -1,7 +1,7 @@
 /*
  * $Id$
  *
- * 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
@@ -27,19 +27,19 @@
 @FUNC@         FcUtf8ToUcs4 
 @TYPE1@                FcChar8 *                       @ARG1@          src
 @TYPE2@                FcChar32 *                      @ARG2@          dst
-@TYPE3@                int                             @ARG3@          len
+@TYPE3@                int%                            @ARG3@          len
 @PURPOSE@      convert UTF-8 to UCS4
 @DESC@
 Converts the next Unicode char from <parameter>src</parameter> into
 <parameter>dst</parameter> and returns the number of bytes containing the
-char.  <parameter>src</parameter> nust be at least
+char.  <parameter>src</parameter> must be at least
 <parameter>len</parameter> bytes long.
 @@
 
 @RET@          int 
 @FUNC@         FcUcs4ToUtf8
-@TYPE1@                FcChar32                        @ARG1@          src      
-@TYPE2@                FcChar8                         @ARG2@          dst[FC_UTF8_MAX_LEN]
+@TYPE1@                FcChar32%                       @ARG1@          src      
+@TYPE2@                FcChar8%                        @ARG2@          dst[FC_UTF8_MAX_LEN]
 @PURPOSE@      convert UCS4 to UTF-8
 @DESC@
 Converts the Unicode char from <parameter>src</parameter> into
@@ -50,7 +50,7 @@ the char.
 @RET@          FcBool 
 @FUNC@         FcUtf8Len
 @TYPE1@                FcChar8 *                       @ARG1@          src
-@TYPE2@                int                             @ARG2@          len
+@TYPE2@                int%                            @ARG2@          len
 @TYPE3@                int *                           @ARG3@          nchar
 @TYPE4@                int *                           @ARG4@          wchar
 @PURPOSE@      count UTF-8 encoded chars
@@ -66,9 +66,9 @@ well-formed UTF8 string.
 @RET@          int 
 @FUNC@         FcUtf16ToUcs4
 @TYPE1@                FcChar8 *                       @ARG1@          src
-@TYPE2@                FcEndian                        @ARG2@          endian
+@TYPE2@                FcEndian%                       @ARG2@          endian
 @TYPE3@                FcChar32 *                      @ARG3@          dst
-@TYPE4@                int                             @ARG4@          len
+@TYPE4@                int%                            @ARG4@          len
 @PURPOSE@      convert UTF-16 to UCS4
 @DESC@
 Converts the next Unicode char from <parameter>src</parameter> into
@@ -81,8 +81,8 @@ units according to <parameter>endian</parameter>.
 @RET@          FcBool
 @FUNC@         FcUtf16Len
 @TYPE1@                FcChar8 *                       @ARG1@          src
-@TYPE2@                FcEndian                        @ARG2@          endian
-@TYPE3@                int                             @ARG3@          len
+@TYPE2@                FcEndian%                       @ARG2@          endian
+@TYPE3@                int%                            @ARG3@          len
 @TYPE4@                int *                           @ARG4@          nchar
 @TYPE5@                int *                           @ARG5@          wchar
 @PURPOSE@      count UTF-16 encoded chars
@@ -107,6 +107,15 @@ buffer.  Yes, this is <function>strdup</function>, but that function isn't
 available on every platform.
 @@
 
+@RET@          FcChar8 *
+@FUNC@         FcStrDowncase
+@TYPE1@                const FcChar8 *                 @ARG1@          s
+@PURPOSE@      create a lower case translation of a string
+@DESC@
+Allocates memory, copies <parameter>s</parameter>, converting upper case
+letters to lower case and returns the allocated buffer.
+@@
+
 @RET@          FcChar8 *
 @FUNC@         FcStrCopyFilename
 @TYPE1@                const FcChar8 *                 @ARG1@          s
@@ -119,8 +128,8 @@ Returns NULL if '~' is present in <parameter>s</parameter> and HOME is unset.
 
 @RET@          int
 @FUNC@         FcStrCmpIgnoreCase
-@TYPE1@                const char *                    @ARG1@          s1
-@TYPE2@                const char *                    @ARG2@          s2
+@TYPE1@                const FcChar8 *                 @ARG1@          s1
+@TYPE2@                const FcChar8 *                 @ARG2@          s2
 @PURPOSE@      compare UTF-8 strings ignoring ASCII case
 @DESC@
 Returns the usual &lt;0, 0, &gt;0 result of comparing
@@ -129,6 +138,33 @@ case-insensitive in the ASCII range and will operate properly with UTF8
 encoded strings, although it does not check for well formed strings.
 @@
 
+@RET@          FcChar8 *
+@FUNC@         FcStrStr
+@TYPE1@                const char *                    @ARG1@          s1
+@TYPE2@                const char *                    @ARG2@          s2
+@PURPOSE@      locate UTF-8 substring
+@DESC@
+Returns the location of <parameter>s2</parameter> in
+<parameter>s1</parameter>.  Returns NULL if <parameter>s2</parameter>
+is not present in <parameter>s1</parameter>. This test will operate properly
+with UTF8 encoded strings, although it does not check for well formed
+strings.
+@@
+
+@RET@          FcChar8 *
+@FUNC@         FcStrStrIgnoreCase
+@TYPE1@                const char *                    @ARG1@          s1
+@TYPE2@                const char *                    @ARG2@          s2
+@PURPOSE@      locate UTF-8 substring ignoring ASCII case
+@DESC@
+Returns the location of <parameter>s2</parameter> in 
+<parameter>s1</parameter>, ignoring ASCII case.  Returns NULL if
+<parameter>s2</parameter> is not present in <parameter>s1</parameter>.
+This test is case-insensitive in the ASCII range and will operate properly
+with UTF8 encoded strings, although it does not check for well formed
+strings.
+@@
+
 @RET@          FcChar8 *
 @FUNC@         FcStrDirname
 @TYPE1@                const FcChar8 *                 @ARG1@          file