summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAkira TAGOH <akira@tagoh.org>2014-03-27 15:10:44 +0900
committerAkira TAGOH <akira@tagoh.org>2017-11-07 15:24:54 +0900
commit9a0fcb948fe7346f6c68028b2e54ab600a2a2a6f (patch)
tree34cd373fb1529028fc8bb68526227e85ac520ad4 /doc
parent0c149259e4cc8070f6c8bf149290abb1367f340a (diff)
Add the ruleset description support
Trying to address what these configuration files really do. This change allows to see the short description that mention the purpose of the content in the config file and obtain them through API. This change also encourage one who want to make some UI for the user-specific configuration management. it is the main purpose of this change for me though. Aside from that, I've also made programs translatable. so we see more dependencies on the build time for gettext, and itstool to generate PO from xml.
Diffstat (limited to 'doc')
-rw-r--r--doc/fcconfig.fncs35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index 80f9b58c..de7a5d79 100644
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -410,3 +410,38 @@ this function calls FcConfigSetCurrent() internally.
@SINCE@ 2.10.92
@@
+@RET@ void
+@FUNC@ FcConfigFileInfoIterInit
+@TYPE1@ FcConfig * @ARG1@ config
+@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
+@PURPOSE@ Initialize the iterator
+@DESC@
+Initialize 'iter' with the first iterator in the config file information list.
+@SINCE@ 2.12.91
+@@
+
+@RET@ FcBool
+@FUNC@ FcConfigFileInfoIterNext
+@TYPE1@ FcConfig * @ARG1@ config
+@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
+@PURPOSE@ Set the iterator to point to the next list
+@DESC@
+Set 'iter' to point to the next node in the config file information list.
+If there is no next node, FcFalse is returned.
+@SINCE@ 2.12.91
+@@
+
+@RET@ FcBool
+@FUNC@ FcConfigFileInfoIterGet
+@TYPE1@ FcConfig * @ARG1@ config
+@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
+@TYPE3@ FcChar8 ** @ARG3@ name
+@TYPE4@ FcChar8 ** @ARG4@ description
+@TYPE5@ FcBool * @ARG5@ enabled
+@PURPOSE@ Obtain the configuration file information
+@DESC@
+Obtain the filename, the description and the flag whether it is enabled or not
+for 'iter' where points to current configuration file information.
+If the iterator is invalid, FcFalse is returned.
+@SINCE@ 2.12.91
+@@