From fcba9ef01c978323fc71c17e455d3cd6ae35edcc Mon Sep 17 00:00:00 2001 From: Akira TAGOH Date: Wed, 26 Mar 2014 16:01:49 +0900 Subject: Fix missing docs --- doc/Makefile.am | 1 + doc/fcpattern.fncs | 27 +++++++++++++++++--- doc/fcrange.fncs | 64 +++++++++++++++++++++++++++++++++++++++++++++++ doc/fontconfig-devel.sgml | 7 ++++++ 4 files changed, 95 insertions(+), 4 deletions(-) create mode 100644 doc/fcrange.fncs (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 78a7cdbf..7503219b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -81,6 +81,7 @@ DOC_FUNCS_FNCS = \ fcobjectset.fncs \ fcobjecttype.fncs \ fcpattern.fncs \ + fcrange.fncs \ fcstring.fncs \ fcstrset.fncs \ fcvalue.fncs \ diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs index 1df1c4f6..1049d77a 100644 --- a/doc/fcpattern.fncs +++ b/doc/fcpattern.fncs @@ -181,12 +181,21 @@ values added to the list have binding weak instead of FcPatternAddRange 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. + +FcPatternGetRange are available since 2.11.91. @@ @RET@ FcPattern * diff --git a/doc/fcrange.fncs b/doc/fcrange.fncs new file mode 100644 index 00000000..60545952 --- /dev/null +++ b/doc/fcrange.fncs @@ -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@ +FcRangeCopy creates a new FcRange object and +populates it with the contents of range. +@SINCE@ 2.11.91 +@@ + +@RET@ FcRange * +@FUNC@ FcRangeCreateDouble +@TYPE1@ double @ARG1@ begin +@TYPE2@ double @ARG2@ end +@PURPOSE@ create a range object for double +@DESC@ +FcRangeCreateDouble 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@ +FcRangeCreateInteger 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@ +FcRangeDestroy destroys a FcRange object, freeing +all memory associated with it. +@SINCE@ 2.11.91 +@@ diff --git a/doc/fontconfig-devel.sgml b/doc/fontconfig-devel.sgml index 7306d792..e2cb1c28 100644 --- a/doc/fontconfig-devel.sgml +++ b/doc/fontconfig-devel.sgml @@ -16,6 +16,7 @@ + @@ -508,6 +509,12 @@ FcMatrix structures hold an affine transformation in matrix form. &fcmatrix; + FcRange + +An FcRange holds two variables to indicate a range in between. + + &fcrange; + FcConfig An FcConfig object holds the internal representation of a configuration. -- cgit v1.2.3