summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAkira TAGOH <akira@tagoh.org>2014-03-07 19:42:21 +0900
committerAkira TAGOH <akira@tagoh.org>2014-03-07 19:42:21 +0900
commitf8ccf379eb1092592ae0b65deb563c5491f69de9 (patch)
treed228d4a7e8c95b8cdb0a4a764eb8d52e76be159c /doc
parent39a2f1e8f98d27b929d56a55a68b3a20d2f8dd32 (diff)
Update doc to include the version info of `since when'
Version section was getting confused to the API's availability, even though it was the version the doc was genereated. So moving it into the footer and added @SINCE@ field in the data.
Diffstat (limited to 'doc')
-rw-r--r--doc/fccache.fncs2
-rw-r--r--doc/fccharset.fncs1
-rw-r--r--doc/fcconfig.fncs2
-rw-r--r--doc/fcdircache.fncs1
-rw-r--r--doc/fcformat.fncs1
-rw-r--r--doc/fclangset.fncs6
-rw-r--r--doc/fcstrset.fncs1
-rw-r--r--doc/func.sgml9
8 files changed, 19 insertions, 4 deletions
diff --git a/doc/fccache.fncs b/doc/fccache.fncs
index ca8ffa03..34ce63f2 100644
--- a/doc/fccache.fncs
+++ b/doc/fccache.fncs
@@ -74,6 +74,7 @@ FcCacheCopySet.
@PURPOSE@
This tries to clean up the cache directory of <parameter>cache_dir</parameter>.
This returns FcTrue if the operation is successfully complete. otherwise FcFalse.
+@SINCE@ 2.9.91
@@
@RET@ void
@@ -83,4 +84,5 @@ This returns FcTrue if the operation is successfully complete. otherwise FcFalse
@DESC@
This tries to create CACHEDIR.TAG file at the cache directory registered
to <parameter>config</parameter>.
+@SINCE@ 2.9.91
@@
diff --git a/doc/fccharset.fncs b/doc/fccharset.fncs
index efcd0ccf..7245a2a0 100644
--- a/doc/fccharset.fncs
+++ b/doc/fccharset.fncs
@@ -60,6 +60,7 @@ running out of memory.
<function>FcCharSetDelChar</function> deletes a single Unicode char from the set,
returning FcFalse on failure, either as a result of a constant set or from
running out of memory.
+@SINCE@ 2.9.0
@@
@RET@ FcCharSet *
diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index 0491a566..24d7121e 100644
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -378,6 +378,7 @@ parse error, semantic error or allocation failure. Otherwise returns FcTrue.
@PURPOSE@ Obtain the system root directory
@DESC@
Obtrains the system root directory in 'config' if available.
+@SINCE@ 2.10.92
@@
@RET@ void
@@ -390,5 +391,6 @@ Set 'sysroot' as the system root directory. fontconfig prepend 'sysroot'
to the cache directories in order to allow people to generate caches at
the build time. Note that this causes changing current config. i.e.
this function calls FcConfigSetCurrent() internally.
+@SINCE@ 2.10.92
@@
diff --git a/doc/fcdircache.fncs b/doc/fcdircache.fncs
index ab5e3d9a..faeba292 100644
--- a/doc/fcdircache.fncs
+++ b/doc/fcdircache.fncs
@@ -62,6 +62,7 @@ FcDirCacheRead.
@DESC@
Re-scan directories only at <parameter>dir</parameter> and update the cache.
returns NULL if failed.
+@SINCE@ 2.11.1
@@
@RET@ FcCache *
diff --git a/doc/fcformat.fncs b/doc/fcformat.fncs
index c136e8cf..71b866b8 100644
--- a/doc/fcformat.fncs
+++ b/doc/fcformat.fncs
@@ -305,4 +305,5 @@ For example, the format "%{family|downcase|delete( )}\n" will expand
to the values of the family element in <parameter>pattern</parameter>,
lower-cased and with spaces removed.
+@SINCE@ 2.9.0
@@
diff --git a/doc/fclangset.fncs b/doc/fclangset.fncs
index c08d60c7..c7ed83b3 100644
--- a/doc/fclangset.fncs
+++ b/doc/fclangset.fncs
@@ -68,6 +68,7 @@ two or three letter language from ISO 639 and Tt is a territory from ISO
<parameter>lang</parameter> should be of the form Ll-Tt where Ll is a
two or three letter language from ISO 639 and Tt is a territory from ISO
3166.
+@SINCE@ 2.9.0
@@
@RET@ FcLangSet *
@@ -77,6 +78,7 @@ two or three letter language from ISO 639 and Tt is a territory from ISO
@PURPOSE@ Add langsets
@DESC@
Returns a set including only those languages found in either <parameter>ls_a</parameter> or <parameter>ls_b</parameter>.
+@SINCE@ 2.9.0
@@
@RET@ FcLangSet *
@@ -86,6 +88,7 @@ Returns a set including only those languages found in either <parameter>ls_a</pa
@PURPOSE@ Subtract langsets
@DESC@
Returns a set including only those languages found in <parameter>ls_a</parameter> but not in <parameter>ls_b</parameter>.
+@SINCE@ 2.9.0
@@
@RET@ FcLangResult
@@ -161,6 +164,8 @@ has no matching language, this function returns FcLangDifferentLang.
Returns a string set of the default languages according to the environment variables on the system.
This function looks for them in order of FC_LANG, LC_ALL, LC_CTYPE and LANG then.
If there are no valid values in those environment variables, "en" will be set as fallback.
+@SINCE@ 2.9.91
+@@
@RET@ FcStrSet *
@FUNC@ FcLangSetGetLangs
@@ -184,6 +189,7 @@ Returns a string set of all known languages.
@PURPOSE@ Normalize the language string
@DESC@
Returns a string to make <parameter>lang</parameter> suitable on fontconfig.
+@SINCE@ 2.10.91
@@
@RET@ const FcCharSet *
diff --git a/doc/fcstrset.fncs b/doc/fcstrset.fncs
index b96489a4..67aa61ac 100644
--- a/doc/fcstrset.fncs
+++ b/doc/fcstrset.fncs
@@ -104,6 +104,7 @@ Creates an iterator to list the strings in <parameter>set</parameter>.
@PURPOSE@ get first string in iteration
@DESC@
Returns the first string in <parameter>list</parameter>.
+@SINCE@ 2.11.0
@@
@RET@ FcChar8 *
diff --git a/doc/func.sgml b/doc/func.sgml
index 73e7761c..f076baff 100644
--- a/doc/func.sgml
+++ b/doc/func.sgml
@@ -33,6 +33,7 @@
<refentrytitle>@FUNC@</refentrytitle>
@;@
<manvolnum>3</manvolnum>
+ <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
</refmeta>
<refnamediv>
@{PROTOTYPE@
@@ -82,9 +83,9 @@
@DESC@
</para>
</refsect1>
- <refsect1><title>Version</title>
- <para>
-Fontconfig version &version;
- </para>
+@?SINCE@
+ <refsect1><title>Since</title>
+ <para>version @SINCE@</para>
</refsect1>
+@;@
</refentry>