diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 4 | ||||
| -rw-r--r-- | docs/pango-docs.sgml | 2 | ||||
| -rw-r--r-- | docs/pango-sections.txt | 23 | ||||
| -rw-r--r-- | docs/tmpl/utils.sgml | 204 |
4 files changed, 230 insertions, 3 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 775d303c..560939a3 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -19,9 +19,8 @@ CFILE_GLOB=$(top_srcdir)/pango/*.c # Headers to ignore IGNORE_HFILES= \ mini-fribidi \ - mini-xft \ - module-defs.h \ opentype \ + module-defs.h \ modules.h \ pangocairo-private.h \ pangocairo-fc.h \ @@ -33,7 +32,6 @@ IGNORE_HFILES= \ pango-glyph-item-private.h \ pango-layout-private.h \ pango-script-table.h \ - pango-utils.h \ pangofc-private.h \ pangoft2-private.h \ pangowin32-private.h \ diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml index 9623b20c..7dbbc10d 100644 --- a/docs/pango-docs.sgml +++ b/docs/pango-docs.sgml @@ -23,6 +23,7 @@ <!ENTITY PangoFcFont SYSTEM "xml/pangofc-font.xml"> <!ENTITY PangoFcDecoder SYSTEM "xml/pangofc-decoder.xml"> <!ENTITY pango-OpenType-Font-Handling SYSTEM "xml/opentype.xml"> +<!ENTITY pango-Misc-Utils SYSTEM "xml/utils.xml"> <!ENTITY markup-format SYSTEM "pango_markup.sgml"> <!ENTITY pango-querymodules SYSTEM "pango-querymodules.xml"> <!ENTITY version SYSTEM "version.xml"> @@ -66,6 +67,7 @@ &PangoEngineLang; &PangoEngineShape; &pango-Modules; + &pango-Misc-Utils; </chapter> <chapter id="tools"> diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt index 72799bcb..cffccd68 100644 --- a/docs/pango-sections.txt +++ b/docs/pango-sections.txt @@ -923,3 +923,26 @@ pango_ot_ruleset_substitute pango_ot_ruleset_position </SECTION> +<SECTION> +<TITLE>Miscellaneous Utilities</TITLE> +<FILE>utils</FILE> +pango_split_file_list +pango_trim_string +pango_read_line +pango_skip_space +pango_scan_word +pango_scan_string +pango_scan_int +pango_config_key_get +pango_lookup_aliases +pango_parse_style +pango_parse_variant +pango_parse_weight +pango_parse_stretch +pango_get_sysconf_subdirectory +pango_get_lib_subdirectory +pango_log2vis_get_embedding_levels +pango_language_get_sample_string +pango_is_zero_width +pango_quantize_line_geometry +</SECTION> diff --git a/docs/tmpl/utils.sgml b/docs/tmpl/utils.sgml new file mode 100644 index 00000000..48a03c3f --- /dev/null +++ b/docs/tmpl/utils.sgml @@ -0,0 +1,204 @@ +<!-- ##### SECTION Title ##### --> +Miscellaneous Utilities + +<!-- ##### SECTION Short_Description ##### --> +Various convenience and utility functions + +<!-- ##### SECTION Long_Description ##### --> +<para> +The functions and utilities in this section are mostly used from Pango +backends and modules, but may be useful for other purposes too. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION pango_parse_style ##### --> +<para> + +</para> + +@str: +@style: +@warn: +@Returns: + + +<!-- ##### FUNCTION pango_parse_weight ##### --> +<para> + +</para> + +@str: +@weight: +@warn: +@Returns: + + +<!-- ##### FUNCTION pango_is_zero_width ##### --> +<para> + +</para> + +@ch: +@Returns: + + +<!-- ##### FUNCTION pango_scan_int ##### --> +<para> + +</para> + +@pos: +@out: +@Returns: + + +<!-- ##### FUNCTION pango_get_lib_subdirectory ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION pango_quantize_line_geometry ##### --> +<para> + +</para> + +@thickness: +@position: + + +<!-- ##### FUNCTION pango_language_get_sample_string ##### --> +<para> + +</para> + +@language: +@Returns: + + +<!-- ##### FUNCTION pango_skip_space ##### --> +<para> + +</para> + +@pos: +@Returns: + + +<!-- ##### FUNCTION pango_parse_variant ##### --> +<para> + +</para> + +@str: +@variant: +@warn: +@Returns: + + +<!-- ##### FUNCTION pango_scan_string ##### --> +<para> + +</para> + +@pos: +@out: +@Returns: + + +<!-- ##### FUNCTION pango_read_line ##### --> +<para> + +</para> + +@stream: +@str: +@Returns: + + +<!-- ##### FUNCTION pango_config_key_get ##### --> +<para> + +</para> + +@key: +@Returns: + + +<!-- ##### FUNCTION pango_scan_word ##### --> +<para> + +</para> + +@pos: +@out: +@Returns: + + +<!-- ##### FUNCTION pango_get_sysconf_subdirectory ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION pango_trim_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION pango_log2vis_get_embedding_levels ##### --> +<para> + +</para> + +@text: +@length: +@pbase_dir: +@Returns: +<!-- # Unused Parameters # --> +@str: +@bytelen: + + +<!-- ##### FUNCTION pango_parse_stretch ##### --> +<para> + +</para> + +@str: +@stretch: +@warn: +@Returns: + + +<!-- ##### FUNCTION pango_lookup_aliases ##### --> +<para> + +</para> + +@fontname: +@families: +@n_families: + + +<!-- ##### FUNCTION pango_split_file_list ##### --> +<para> + +</para> + +@str: +@Returns: + + |