Fix missing docs

This commit is contained in:
Akira TAGOH 2014-03-26 16:01:49 +09:00
parent fff91eee7d
commit fcba9ef01c
4 changed files with 95 additions and 4 deletions

View File

@ -81,6 +81,7 @@ DOC_FUNCS_FNCS = \
fcobjectset.fncs \
fcobjecttype.fncs \
fcpattern.fncs \
fcrange.fncs \
fcstring.fncs \
fcstrset.fncs \
fcvalue.fncs \

View File

@ -181,12 +181,21 @@ values added to the list have binding <parameter>weak</parameter> instead of <pa
@TYPE2+++++++@ const char * @ARG2+++++++@ object
@TYPE3+++++++@ const FcLangSet * @ARG3+++++++@ l
@PROTOTYPE++++++++@
@RET++++++++@ FcBool
@FUNC++++++++@ FcPatternAddRange
@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p
@TYPE2++++++++@ const char * @ARG2++++++++@ object
@TYPE3++++++++@ const FcRange * @ARG3++++++++@ r
@PURPOSE@ Add a typed value to a pattern
@DESC@
These are all convenience functions that insert objects of the specified
type into the pattern. Use these in preference to FcPatternAdd as they
will provide compile-time typechecking. These all append values to
any existing list of values.
<function>FcPatternAddRange</function> are available since 2.11.91.
@@
@RET@ FcResult
@ -257,16 +266,24 @@ within the pattern directly. Applications must not free this value.
@FUNC++++++@ FcPatternGetFTFace
@TYPE1++++++@ FcPattern * @ARG1++++++@ p
@TYPE2++++++@ const char * @ARG2++++++@ object
@TYPE3+++++@ int% @ARG3+++++@ n
@TYPE3++++++@ FT_Face * @ARG3++++++@ f
@TYPE3++++++@ int% @ARG3++++++@ n
@TYPE4++++++@ FT_Face * @ARG4++++++@ f
@PROTOTYPE+++++++@
@RET+++++++@ FcResult
@FUNC+++++++@ FcPatternGetLangSet
@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p
@TYPE2+++++++@ const char * @ARG2+++++++@ object
@TYPE3+++++@ int% @ARG3+++++@ n
@TYPE3+++++++@ FcLangSet ** @ARG3+++++++@ l
@TYPE3+++++++@ int% @ARG3+++++++@ n
@TYPE4+++++++@ FcLangSet ** @ARG4+++++++@ l
@PROTOTYPE++++++++@
@RET++++++++@ FcResult
@FUNC++++++++@ FcPatternGetRange
@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p
@TYPE2++++++++@ const char * @ARG2++++++++@ object
@TYPE3++++++++@ int% @ARG3++++++++@ n
@TYPE4++++++++@ FcRange ** @ARG4++++++++@ r
@PURPOSE@ Return a typed value from a pattern
@DESC@
@ -275,6 +292,8 @@ returned data is of the expected type. They return FcResultTypeMismatch if
this is not the case. Note that these (like FcPatternGet) do not make a
copy of any data structure referenced by the return value. Use these
in preference to FcPatternGet to provide compile-time typechecking.
<function>FcPatternGetRange</function> are available since 2.11.91.
@@
@RET@ FcPattern *

64
doc/fcrange.fncs Normal file
View File

@ -0,0 +1,64 @@
/*
* fontconfig/doc/fcrange.fncs
*
* 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 the author(s) not be used in
* advertising or publicity pertaining to distribution of the software without
* 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.
*
* THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
* 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
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcRange *
@FUNC@ FcRangeCopy
@TYPE1@ const FcRange * @ARG1@ range
@PURPOSE@ Copy a range object
@DESC@
<function>FcRangeCopy</function> creates a new FcRange object and
populates it with the contents of <parameter>range</parameter>.
@SINCE@ 2.11.91
@@
@RET@ FcRange *
@FUNC@ FcRangeCreateDouble
@TYPE1@ double @ARG1@ begin
@TYPE2@ double @ARG2@ end
@PURPOSE@ create a range object for double
@DESC@
<function>FcRangeCreateDouble</function> creates a new FcRange object with
double sized value.
@SINCE@ 2.11.91
@@
@RET@ FcRange *
@FUNC@ FcRangeCreateInteger
@TYPE1@ int @ARG1@ begin
@TYPE2@ int @ARG2@ end
@PURPOSE@ create a range object for integer
@DESC@
<function>FcRangeCreateInteger</function> creates a new FcRange object with
integer sized value.
@SINCE@ 2.11.91
@@
@RET@ void
@FUNC@ FcRangeDestroy
@TYPE1@ FcRange * @ARG1@ range
@PURPOSE@ destroy a range object
@DESC@
<function>FcRangeDestroy</function> destroys a FcRange object, freeing
all memory associated with it.
@SINCE@ 2.11.91
@@

View File

@ -16,6 +16,7 @@
<!ENTITY fcobjectset SYSTEM "fcobjectset.sgml">
<!ENTITY fcobjecttype SYSTEM "fcobjecttype.sgml">
<!ENTITY fcpattern SYSTEM "fcpattern.sgml">
<!ENTITY fcrange SYSTEM "fcrange.sgml">
<!ENTITY fcstring SYSTEM "fcstring.sgml">
<!ENTITY fcstrset SYSTEM "fcstrset.sgml">
<!ENTITY fcvalue SYSTEM "fcvalue.sgml">
@ -508,6 +509,12 @@ FcMatrix structures hold an affine transformation in matrix form.
</para>
&fcmatrix;
</sect2>
<sect2><title>FcRange</title>
<para>
An FcRange holds two variables to indicate a range in between.
</para>
&fcrange;
</sect2>
<sect2><title>FcConfig</title>
<para>
An FcConfig object holds the internal representation of a configuration.