From: Keith Packard <keithp@koto.keithp.com>
Date: Sun, 4 Nov 2007 06:03:11 +0000 (-0700)
Subject: Replace incorrect documentation uses of 'char' with 'FcChar8' (bug 13002).
X-Git-Tag: 2.4.92~20
X-Git-Url: https://git.wh0rd.org/?p=fontconfig.git;a=commitdiff_plain;h=f2772d6b45bcfc27618968fdbb08dcc50a18be22

Replace incorrect documentation uses of 'char' with 'FcChar8' (bug 13002).
---

diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index 0081d06..bf4f1dd 100644
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -123,7 +123,7 @@ filesystem.
 Returns the list of known configuration files used to generate <parameter>config</parameter>.
 @@
 
-@RET@           char *
+@RET@           FcChar8 *
 @FUNC@          FcConfigGetCache
 @TYPE1@         FcConfig *                      @ARG1@          config
 @PURPOSE@	DEPRECATED used to return per-user cache filename
@@ -183,7 +183,7 @@ Sets the rescan interval; returns FcFalse if an error occurred.
 @RET@           FcBool
 @FUNC@          FcConfigAppFontAddFile
 @TYPE1@         FcConfig *			@ARG1@		config
-@TYPE2@		const char *                    @ARG2@          file
+@TYPE2@		const FcChar8 *			@ARG2@          file
 @PURPOSE@	Add font file to font database
 @DESC@
 Adds an application-specific font to the configuration.
@@ -192,7 +192,7 @@ Adds an application-specific font to the configuration.
 @RET@           FcBool
 @FUNC@          FcConfigAppFontAddDir
 @TYPE1@         FcConfig *			@ARG1@		config
-@TYPE2@		const char *                    @ARG1@          dir
+@TYPE2@		const FcChar8 *			@ARG2@          dir
 @PURPOSE@	Add fonts from directory to font database
 @DESC@
 Scans the specified directory for fonts, adding each one found to the
@@ -291,9 +291,9 @@ Selects fonts matching <parameter>p</parameter>, creates patterns from those fon
 only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
 @@
 
-@RET@           char *
+@RET@           FcChar8 *
 @FUNC@          FcConfigFilename
-@TYPE1@         const char *                    @ARG1@          name
+@TYPE1@         const FcChar8 *			@ARG1@          name
 @PURPOSE@	Find a config file
 @DESC@
 Given the specified external entity name, return the associated filename.
diff --git a/doc/fcfile.fncs b/doc/fcfile.fncs
index 98b8f81..4821365 100644
--- a/doc/fcfile.fncs
+++ b/doc/fcfile.fncs
@@ -28,7 +28,7 @@
 @TYPE2@		FcStrSet *			@ARG2@		dirs	
 @TYPE3@		FcFileCache *			@ARG3@		cache	
 @TYPE4@		FcBlanks *			@ARG4@		blanks	
-@TYPE5@		const char *			@ARG5@		file	
+@TYPE5@		const FcChar8 *			@ARG5@		file	
 @TYPE6@		FcBool% 				@ARG6@		force	
 @PURPOSE@	scan a font file
 @DESC@
@@ -59,7 +59,7 @@ returns FcFalse.
 @TYPE2@		FcStrSet *			@ARG2@		dirs	
 @TYPE3@		FcFileCache *			@ARG3@		cache	
 @TYPE4@		FcBlanks *			@ARG4@		blanks	
-@TYPE5@		const char *			@ARG5@		dir	
+@TYPE5@		const FcChar8 *			@ARG5@		dir	
 @TYPE6@		FcBool% 				@ARG6@		force	
 @PURPOSE@	scan a font directory
 @DESC@
@@ -76,7 +76,7 @@ fontconfig selects which fonts to include.
 @FUNC@		FcDirSave 
 @TYPE1@		FcFontSet *			@ARG1@		set	
 @TYPE2@		FcStrSet *			@ARG2@		dirs	
-@TYPE3@		const char *			@ARG3@		dir	
+@TYPE3@		const FcChar8 *			@ARG3@		dir	
 @PURPOSE@	save a directory cache
 @DESC@
 Creates the per-directory cache file for <parameter>dir</parameter> and
diff --git a/doc/fcfreetype.fncs b/doc/fcfreetype.fncs
index 935eacf..6eb29b1 100644
--- a/doc/fcfreetype.fncs
+++ b/doc/fcfreetype.fncs
@@ -80,7 +80,7 @@ widths.
 #include &lt;fcfreetype.h&gt;
 @RET@           FcPattern *      
 @FUNC@          FcFreeTypeQuery 
-@TYPE1@         const char *			@ARG1@          file      
+@TYPE1@         const FcChar8 *			@ARG1@          file      
 @TYPE2@         int%				@ARG2@          id      
 @TYPE3@         FcBlanks *			@ARG3@          blanks      
 @TYPE4@         int *				@ARG4@          count      
@@ -96,7 +96,7 @@ of fonts in 'file' is returned in 'count'.
 @RET@           FcPattern *      
 @FUNC@          FcFreeTypeQueryFace
 @TYPE1@		const FT_Face%			@ARG1@		face
-@TYPE2@         const char *			@ARG2@          file
+@TYPE2@         const FcChar8 *			@ARG2@          file
 @TYPE3@         int%				@ARG3@          id
 @TYPE4@         FcBlanks *			@ARG4@          blanks
 @PURPOSE@	compute pattern from FT_Face
diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs
index 74f3675..a346cc5 100644
--- a/doc/fcpattern.fncs
+++ b/doc/fcpattern.fncs
@@ -132,7 +132,7 @@ values added to the list have binding <parameter>weak</parameter> instead of <pa
 @FUNC++@	FcPatternAddString
 @TYPE1++@ 	FcPattern * 			@ARG1++@ 	p
 @TYPE2++@	const char *			@ARG2++@	object
-@TYPE3++@	const char *			@ARG3++@	s
+@TYPE3++@	const FcChar8 *			@ARG3++@	s
 
 @PROTOTYPE+++@
 @RET+++@	FcBool
@@ -214,7 +214,7 @@ within the pattern directly.  Applications must not free this value.
 @TYPE1++@	FcPattern *			@ARG1++@	p
 @TYPE2++@	const char *			@ARG2++@	object
 @TYPE3++@	int%				@ARG3++@	n
-@TYPE4++@	char **const			@ARG4++@	s
+@TYPE4++@	FcChar8 **			@ARG4++@	s
 
 @PROTOTYPE+++@
 @RET+++@	FcResult
@@ -356,7 +356,7 @@ specified point size (default 12), dpi (default 75) and scale (default 1).
 
 @RET@		FcPattern *
 @FUNC@		FcNameParse
-@TYPE1@		const char *			@ARG1@		name 
+@TYPE1@		const FcChar8 *			@ARG1@		name 
 @PURPOSE@	Parse a pattern string
 @DESC@
 Converts <parameter>name</parameter> from the standard text format described above into a pattern.
diff --git a/doc/fontconfig-devel.sgml b/doc/fontconfig-devel.sgml
index d448524..3f91e64 100644
--- a/doc/fontconfig-devel.sgml
+++ b/doc/fontconfig-devel.sgml
@@ -269,7 +269,7 @@ types.  The 'type' tag indicates which member is valid.
         FcTypeVoid      (none)          (none)
         FcTypeInteger   i               int
         FcTypeDouble    d               double
-        FcTypeString    s               char *
+        FcTypeString    s               FcChar8 *
         FcTypeBool      b               b
         FcTypeMatrix    m               FcMatrix *
         FcTypeCharSet   c               FcCharSet *