Use <parameter> tags. Add copyrights

diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index efb5dc50e73b16f0410ef9167b9835c428701f19..d6119f2ffd1024466822c78559af034a79bf9cde 100644 (file)
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -44,7 +44,7 @@ in an indeterminate state.
 @TYPE1@         FcConfig *                      @ARG1@          config      
 @PURPOSE@      Set configuration as default
 @DESC@
-Sets the current default configuration to 'config'.  Implicitly calls
+Sets the current default configuration to <parameter>config</parameter>.  Implicitly calls
 FcConfigBuildFonts if necessary, returning FcFalse if that call fails.
 @@
 
@@ -61,7 +61,7 @@ Returns the current default configuration.
 @TYPE1@         FcConfig *                      @ARG1@          config      
 @PURPOSE@      Check timestamps on config files
 @DESC@
-Checks all of the files related to 'config' and returns whether the
+Checks all of the files related to <parameter>config</parameter> and returns whether the
 in-memory version is in sync with the disk version.
 @@
 
@@ -81,7 +81,7 @@ Returns FcFalse if this operation runs out of memory.
 @PURPOSE@      Get config directories
 @DESC@
 Returns the list of font directories specified in the configuration files
-for 'config'.  Does not include any subdirectories.
+for <parameter>config</parameter>.  Does not include any subdirectories.
 @@
 
 @RET@           FcStrList *                    
@@ -89,7 +89,7 @@ for 'config'.  Does not include any subdirectories.
 @TYPE1@         FcConfig *                      @ARG1@          config      
 @PURPOSE@      Get font directories
 @DESC@
-Returns the list of font directories in 'config'. This includes the
+Returns the list of font directories in <parameter>config</parameter>. This includes the
 configured font directories along with any directories below those in the
 filesystem.
 @@
@@ -99,7 +99,7 @@ filesystem.
 @TYPE1@         FcConfig *                      @ARG1@          config      
 @PURPOSE@      Get config files
 @DESC@
-Returns the list of known configuration files used to generate 'config'.
+Returns the list of known configuration files used to generate <parameter>config</parameter>.
 Note that this will not include any configuration done with FcConfigParse.
 @@
 
@@ -118,7 +118,7 @@ Returns the name of the file used to store per-user font information.
 @PURPOSE@      Get config font set
 @DESC@
 Returns one of the two sets of fonts from the configuration as specified 
-by 'set'.
+by <parameter>set</parameter>.
 @@
 
 @RET@           FcBlanks *                     
@@ -136,7 +136,7 @@ blanks were present in the configuration, this function will return 0.
 @PURPOSE@      Get config rescan interval
 @DESC@
 Returns the interval between automatic checks of the configuration (in
-seconds) specified in 'config'.  The configuration is checked during
+seconds) specified in <parameter>config</parameter>.  The configuration is checked during
 a call to FcFontList when this interval has passed since the last check.
 @@
 
@@ -184,9 +184,9 @@ Clears the set of application-specific fonts.
 @TYPE4@                FcMatchKind                     @ARG4@          kind      
 @PURPOSE@      Execute substitutions
 @DESC@
-Performs the sequence of pattern modification operations, if 'kind' is
+Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
 FcMatchPattern, then those tagged as pattern operations are applied, else 
-if 'kind' is FcMatchFont, those tagged as font operations are applied and
+if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
 p_pat is used for &lt;test&gt; elements with target=pattern.
 @@
 
@@ -207,9 +207,9 @@ Calls FcConfigSubstituteWithPat setting p_pat to NULL.
 @TYPE3@                FcResult *                      @ARG3@          result      
 @PURPOSE@      Return best font
 @DESC@
-Returns the font in 'config' most close matching 'p'.  This function
+Returns the font in <parameter>config</parameter> most close matching <parameter>p</parameter>.  This function
 should be called only after FcConfigSubstitute and FcDefaultSubstitute have
-been called for 'p'; otherwise the results will not be correct.
+been called for <parameter>p</parameter>; otherwise the results will not be correct.
 @@
 
 @RET@           FcFontSet *                    
@@ -221,16 +221,16 @@ been called for 'p'; otherwise the results will not be correct.
 @TYPE5@                FcResult *                      @ARG5@          result      
 @PURPOSE@      Return list of matching fonts
 @DESC@
-Returns the list of fonts sorted by closeness to 'p'.  If 'trim' is FcTrue,
+Returns the list of fonts sorted by closeness to <parameter>p</parameter>.  If <parameter>trim</parameter> is FcTrue,
 elements in the list which don't include Unicode coverage not provided by
 earlier elements in the list are elided.  The union of Unicode coverage of
-all of the fonts is returned in 'csp', if 'csp' is not NULL.  This function
+all of the fonts is returned in <parameter>csp</parameter>, if <parameter>csp</parameter> is not NULL.  This function
 should be called only after FcConfigSubstitute and FcDefaultSubstitute have
-been called for 'p'; otherwise the results will not be correct.
+been called for <parameter>p</parameter>; otherwise the results will not be correct.
     </para><para>
 The returned FcFontSet references FcPattern structures which may be shared
 by the return value from multiple FcFontSort calls, applications must not
-modify these patterns.  Instead, they should be passed, along with 'p' to
+modify these patterns.  Instead, they should be passed, along with <parameter>p</parameter> to
 FcFontRenderPrepare which combines them into a complete pattern.
     </para><para>
 The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
@@ -243,10 +243,10 @@ The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
 @TYPE3@                FcPattern *                     @ARG3@          font      
 @PURPOSE@      Prepare pattern for loading font file
 @DESC@
-Creates a new pattern consisting of elements of 'font' not appearing
-in 'pat', elements of 'pat' not appearing in 'font' and the best matching
-value from 'pat' for elements appearing in both.  The result is passed to
-FcConfigSubstitute with 'kind' FcMatchFont and then returned.
+Creates a new pattern consisting of elements of <parameter>font</parameter> not appearing
+in <parameter>pat</parameter>, elements of <parameter>pat</parameter> not appearing in <parameter>font</parameter> and the best matching
+value from <parameter>pat</parameter> for elements appearing in both.  The result is passed to
+FcConfigSubstitute with <parameter>kind</parameter> FcMatchFont and then returned.
 @@
 
 @RET@           FcFontSet *                    
@@ -256,8 +256,8 @@ FcConfigSubstitute with 'kind' FcMatchFont and then returned.
 @TYPE3@                FcObjectSet *                   @ARG3@          os      
 @PURPOSE@      List fonts
 @DESC@
-Selects fonts matching 'p', creates patterns from those fonts containing
-only the objects in 'os' and returns the set of unique such patterns.
+Selects fonts matching <parameter>p</parameter>, creates patterns from those fonts containing
+only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
 @@
 
 @RET@           char *                         
@@ -269,9 +269,9 @@ Given the specified external entity name, return the associated filename.
 This provides applications a way to convert various configuration file
 references into filename form. 
     </para><para>
-A null or empty 'name' indicates that the default configuration file should
+A null or empty <parameter>name</parameter> indicates that the default configuration file should
 be used; which file this references can be overridden with the
-FC_CONFIG_FILE environment variable.  Next, if the name starts with '~', it
+FC_CONFIG_FILE environment variable.  Next, if the name starts with <parameter>~</parameter>, it
 refers to a file in the current users home directory.  Otherwise if the name
 doesn't start with '/', it refers to a file in the default configuration
 directory; the built-in default directory can be overridden with the

diff --git a/doc/fcconstant.fncs b/doc/fcconstant.fncs
index 0ba9d8d395fddba6b5388e0bb0cac03fb264e043..0fe9198db284466f9f743ed7cbab5fc919ac2868 100644 (file)
--- a/doc/fcconstant.fncs
+++ b/doc/fcconstant.fncs
@@ -27,7 +27,7 @@
 @TYPE2@                int                             @ARG2@          nconsts
 @PURPOSE@      Register symbolic constants
 @DESC@
-Register 'nconsts' new symbolic constants.
+Register <parameter>nconsts</parameter> new symbolic constants.
 @@
 
 @RET@          FcBool
@@ -36,7 +36,7 @@ Register 'nconsts' new symbolic constants.
 @TYPE2@                int                             @ARG2@          nconsts
 @PURPOSE@      Unregister symbolic constants
 @DESC@
-Unregister 'nconsts' symbolic constants.
+Unregister <parameter>nconsts</parameter> symbolic constants.
 @@
 
 @RET@          const FcConstant *
@@ -44,7 +44,7 @@ Unregister 'nconsts' symbolic constants.
 @TYPE1@                FcChar8 *                       @ARG1@          string
 @PURPOSE@      Lookup symbolic constant
 @DESC@
-Return the FcConstant structure related to symbolic constant 'string'.
+Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
 @@
 
 @RET@          FcBool
@@ -53,6 +53,6 @@ Return the FcConstant structure related to symbolic constant 'string'.
 @TYPE2@                int *                           @ARG2@          result
 @PURPOSE@      Get the value for a symbolic constant
 @DESC@
-Returns whether a symbolic constant with name 'string' is registered,
-placing the value of the constant in 'result' if present.
+Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
+placing the value of the constant in <parameter>result</parameter> if present.
 @@

diff --git a/doc/fcobjecttype.fncs b/doc/fcobjecttype.fncs
index e10148a2269d12f4e6d92d4fb3f7e84b1292744a..0cf55ea0a6c3e4238b195194e0b1367e3d04d897 100644 (file)
--- a/doc/fcobjecttype.fncs
+++ b/doc/fcobjecttype.fncs
@@ -27,7 +27,7 @@
 @TYPE2@                int                             @ARG2@          ntype
 @PURPOSE@      Register object types
 @DESC@
-Register 'ntype' new object types.
+Register <parameter>ntype</parameter> new object types.
 @@
 
 @RET@          FcBool
@@ -36,7 +36,7 @@ Register 'ntype' new object types.
 @TYPE2@                int                             @ARG2@          ntype
 @PURPOSE@      Unregister object types
 @DESC@
-Unregister 'ntype' object types.
+Unregister <parameter>ntype</parameter> object types.
 @@
 
 @RET@          const FcObjectType *
@@ -44,5 +44,5 @@ Unregister 'ntype' object types.
 @TYPE1@                const char *                    @ARG1@          object
 @PURPOSE@      Lookup an object type
 @DESC@
-Return the object type for the pattern element named 'object'.
+Return the object type for the pattern element named <parameter>object</parameter>.
 @@

diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs
index 4dbbed7b1c7429d99c193529d5066e572c524fa1..1e1e3392bfa5eeffa7ec83bd0a8ea3d98a6e1493 100644 (file)
--- a/doc/fcpattern.fncs
+++ b/doc/fcpattern.fncs
@@ -43,7 +43,7 @@ Destroys a pattern, in the process destroying all related values.
 @TYPE2@                const FcPattern *               @ARG2@          pb 
 @PURPOSE@      Compare patterns
 @DESC@
-Returns whether 'pa' and 'pb' are exactly alike.
+Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> are exactly alike.
 @@
 
 @RET@          FcBool
@@ -53,8 +53,8 @@ Returns whether 'pa' and 'pb' are exactly alike.
 @TYPE3@        const FcObjectSet *             @ARG3@          os 
 @PURPOSE@      Compare portions of patterns
 @DESC@
-Returns whether 'pa' and 'pb' have exactly the same values for all of the
-objects in 'os'.
+Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> have exactly the same values for all of the
+objects in <parameter>os</parameter>.
 @@
 
 @RET@          FcChar32
@@ -75,7 +75,7 @@ equal.
 @PURPOSE@      Add a value to a pattern
 @DESC@
 Adds a single value to the list of values associated with the property named
-`object'.  If `append' is FcTrue, the value is added at the end of any
+`object<parameter>.  If `append</parameter> is FcTrue, the value is added at the end of any
 existing list, otherwise it is inserted at the begining.  `value' is saved
 (with FcValueSave) when inserted into the pattern so that the library
 retains no reference to any application-supplied data structure.
@@ -90,7 +90,7 @@ retains no reference to any application-supplied data structure.
 @PURPOSE@      Add a value to a pattern with weak binding
 @DESC@
 FcPatternAddWeak is essentially the same as FcPatternAdd except that any
-values added to the list have binding 'weak' instead of 'strong'.
+values added to the list have binding <parameter>weak</parameter> instead of <parameter>strong</parameter>.
 @@
 
 @TITLE@                FcPatternAdd-Type
@@ -150,7 +150,7 @@ any existing list of values.
 @TYPE4@                FcValue *                       @ARG4@          v 
 @PURPOSE@      Return a value from a pattern
 @DESC@
-Returns in `v' the `id'th value associated with the property `object'.
+Returns in `v<parameter> the `id</parameter>th value associated with the property `object'.
 The value returned is not a copy, but rather refers to the data stored
 within the pattern directly.  Applications must not free this value.
 @@
@@ -296,7 +296,7 @@ specified point size (default 12), dpi (default 75) and scale (default 1).
 @TYPE1@                const char *                    @ARG1@          name 
 @PURPOSE@      Parse a pattern string
 @DESC@
-Converts 'name' from the standard text format described above into a pattern.
+Converts <parameter>name</parameter> from the standard text format described above into a pattern.
 @@
 
 @RET@          FcChar8 *

diff --git a/doc/fcvalue.fncs b/doc/fcvalue.fncs
index 3f5f294a3acb309ec229223a8224a4089600b731..73cfc0d36cca863b78edf270971840588c52b4db 100644 (file)
--- a/doc/fcvalue.fncs
+++ b/doc/fcvalue.fncs
@@ -26,7 +26,7 @@
 @TYPE1@                FcValue                 @ARG1@          v
 @PURPOSE@      Free a value
 @DESC@
-Frees any memory referenced by `v'.  Values of type FcTypeString,
+Frees any memory referenced by <parameter>v</parameter>.  Values of type FcTypeString,
 FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
 @@
 
@@ -35,6 +35,6 @@ FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
 @TYPE1@                FcValue                 @ARG1@          v
 @PURPOSE@      Copy a value
 @DESC@
-Returns a copy of `v' duplicating any object referenced by it so that `v'
+Returns a copy of <parameter>v</parameter> duplicating any object referenced by it so that <parameter>v</parameter>
 may be safely destroyed without harming the new value.
 @@