diff options
author | Behdad Esfahbod <behdad@gnome.org> | 2006-12-07 03:40:54 +0000 |
---|---|---|
committer | Behdad Esfahbod <behdad@src.gnome.org> | 2006-12-07 03:40:54 +0000 |
commit | d6956a1ad956ad4f5322059fff7baac70ea3c039 (patch) | |
tree | a2fc3a3c05e4753f4ad73893a840ffaa41a4e498 /docs | |
parent | 5b6f118ba4b87c2d9ba834620b11c3f44119dce1 (diff) | |
download | pango-d6956a1ad956ad4f5322059fff7baac70ea3c039.tar.gz |
New generated public header file pango-features.h. Currently contains the
2006-12-06 Behdad Esfahbod <behdad@gnome.org>
* configure.in:
* pango/Makefile.am:
New generated public header file pango-features.h. Currently contains
the version information. In the future, can be expanded to define
which backends have been enabled, etc.
* pango/pango.def:
* pango/pango-utils.h:
* pango/pango-utils.c:
New public macros and functions: PANGO_VERSION_ENCODE(),
PANGO_VERSION_MAJOR, PANGO_VERSION_MINOR, PANGO_VERSION_MICRO,
PANGO_VERSION, PANGO_VERSION_STRING, PANGO_VERSION_CHECK(),
pango_version(), pango_version_string(), pango_version_check().
* docs/pango-docs.sgml:
* docs/pango-sections.txt:
* docs/tmpl/pango-version.sgml:
Docs for new symbols, in a new section.
* examples/renderdemo.c (show_version):
If run-time Pango lib version is different than the compile-time one,
show that one too.
* pango/pango.h:
#include <pango-utils.h> as well as almost all other public pango-*.h
headers (though, the other ones were already included indirectly).
The only public pango-*.h header pango.h shouldn't include are
pango-ot.h (which is really misnamed) and pango-modules.h (that should
not be needed by 99.99% users anyway).
* docs/Makefile.am:
* docs/check.docs: Test to check that all symbols are documented and
properly hooked into documentation tree.
* pango/pango.rc.in:
* pango/pangoft2.rc.in:
* pango/pangowin32.rc.in:
Update, reflecting some internal symbol changes.
* pango/check.defs: Improve.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 5 | ||||
-rwxr-xr-x | docs/check.docs | 29 | ||||
-rw-r--r-- | docs/pango-docs.sgml | 5 | ||||
-rw-r--r-- | docs/pango-sections.txt | 15 | ||||
-rw-r--r-- | docs/tmpl/pango-version.sgml | 110 |
5 files changed, 163 insertions, 1 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 7fc22b0a..a3d665a0 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -98,7 +98,8 @@ endif EXTRA_DIST += \ layout.fig \ layout.eps \ - version.xml.in + version.xml.in \ + check.docs BUILT_EXTRA_DIST = $(man_MANS) @@ -112,3 +113,5 @@ dist-hook-local: for f in $(srcdir)/TEXT/* ; do \ test -f $$f && cp -p $$f $(distdir)/TEXT; \ done + +TESTS = check.docs diff --git a/docs/check.docs b/docs/check.docs new file mode 100755 index 00000000..6703691f --- /dev/null +++ b/docs/check.docs @@ -0,0 +1,29 @@ +#!/bin/bash + +LANG=C + +test -z "$srcdir" && srcdir=. +status=0 + +if ! test -f pango-undocumented.txt -a -f pango-unused.txt; then + echo At least one of pango-undocumented.txt and pango-unused.txt not found. + echo Skipping test. + exit 0 +fi + +status=0 + +unused=`cat pango-unused.txt` +if test -n "$unused"; then + echo Unused documentated symbols: + cat pango-unused.txt + status=1 +fi +if ! grep '^0 symbols incomplete' pango-undocumented.txt >/dev/null || + ! grep '^0 not documented' pango-undocumented.txt >/dev/null; then + echo Incomplete or undocumented symbols: + cat pango-unused.txt + status=1 +fi + +exit $status diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml index 0b64ff0e..a9bfe030 100644 --- a/docs/pango-docs.sgml +++ b/docs/pango-docs.sgml @@ -27,6 +27,7 @@ <!ENTITY pango-Misc-Utils SYSTEM "xml/utils.xml"> <!ENTITY markup-format SYSTEM "pango_markup.sgml"> <!ENTITY pango-querymodules SYSTEM "pango-querymodules.xml"> +<!ENTITY pango-Version SYSTEM "xml/pango-version.xml"> <!ENTITY version SYSTEM "version.xml"> ]> <book id="index"> @@ -70,6 +71,7 @@ &PangoEngineShape; &pango-Modules; &pango-Misc-Utils; + &pango-Version; </chapter> <chapter id="tools"> @@ -104,4 +106,7 @@ <index role="1.14"> <title>Index of new symbols in 1.14</title> </index> + <index role="1.16"> + <title>Index of new symbols in 1.16</title> + </index> </book> diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt index ba268e5e..c684a02d 100644 --- a/docs/pango-sections.txt +++ b/docs/pango-sections.txt @@ -970,3 +970,18 @@ pango_language_get_sample_string pango_is_zero_width pango_quantize_line_geometry </SECTION> + +<SECTION> +<TITLE>Version Checking</TITLE> +<FILE>pango-version</FILE> +PANGO_VERSION_ENCODE +PANGO_VERSION +PANGO_VERSION_MAJOR +PANGO_VERSION_MINOR +PANGO_VERSION_MICRO +PANGO_VERSION_STRING +PANGO_VERSION_CHECK +pango_version +pango_version_string +pango_version_check +</SECTION> diff --git a/docs/tmpl/pango-version.sgml b/docs/tmpl/pango-version.sgml new file mode 100644 index 00000000..dbdb41a2 --- /dev/null +++ b/docs/tmpl/pango-version.sgml @@ -0,0 +1,110 @@ +<!-- ##### SECTION Title ##### --> +Version Checking + +<!-- ##### SECTION Short_Description ##### --> +Tools for checking Pango version at compile- and run-time. + +<!-- ##### SECTION Long_Description ##### --> +<para> +The capital-letter macros defined here can be used to check the version of +Pango at compile-time, and to <firstterm>encode</firstterm> Pango versions into +integers. + +The functions can be used to check the version of the linked Pango library +at run-time. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO PANGO_VERSION_ENCODE ##### --> +<para> +This macro encodes the given Pango version into an integer. The numbers +returned by %PANGO_VERSION and pango_version() are encoded using this macro. +Two encoded version numbers can be compared as integers. +</para> + +@major: the major component of the version number +@minor: the minor component of the version number +@micro: the micro component of the version number + + +<!-- ##### MACRO PANGO_VERSION ##### --> +<para> +The version of Pango available at compile-time, encoded using +PANGO_VERSION_ENCODE(). +</para> + + + +<!-- ##### MACRO PANGO_VERSION_MAJOR ##### --> +<para> +The major component of the version of Pango available at compile-time. +</para> + + + +<!-- ##### MACRO PANGO_VERSION_MINOR ##### --> +<para> +The minor component of the version of Pango available at compile-time. +</para> + + + +<!-- ##### MACRO PANGO_VERSION_MICRO ##### --> +<para> +The micro component of the version of Pango available at compile-time. +</para> + + + +<!-- ##### MACRO PANGO_VERSION_STRING ##### --> +<para> +A string literal containing the version of Pango available at compile-time. +</para> + + + +<!-- ##### MACRO PANGO_VERSION_CHECK ##### --> +<para> +Checks that the versoin of Pango available at compile-time is not older than +the provided version number. +</para> + +@major: the major component of the version number +@minor: the minor component of the version number +@micro: the micro component of the version number + + +<!-- ##### FUNCTION pango_version ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION pango_version_string ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION pango_version_check ##### --> +<para> + +</para> + +@required_major: +@required_minor: +@required_micro: +@Returns: + + |