[cairo-commit] 3 commits - doc/public

Behdad Esfahbod behdad at kemper.freedesktop.org
Wed Dec 6 21:02:18 PST 2006


 doc/public/Headers.mk              |   31 ++++++++++++++++++++
 doc/public/Makefile.am             |   57 ++++++++++++++-----------------------
 doc/public/cairo-sections.txt      |   18 +++++++++++
 doc/public/tmpl/cairo-version.sgml |   20 +++++++-----
 4 files changed, 84 insertions(+), 42 deletions(-)

New commits:
diff-tree 9b87fab8ce283e966da7ac850980397cb9e199cc (from 0e028ee0f3bfb95d8483bb4c84b84c4bd53b8c53)
Author: Behdad Esfahbod <behdad at behdad.org>
Date:   Wed Dec 6 23:52:22 2006 -0500

    [docs] Hook various new API into cairo-sections.txt

diff --git a/doc/public/cairo-sections.txt b/doc/public/cairo-sections.txt
index c18bc05..c79453f 100644
--- a/doc/public/cairo-sections.txt
+++ b/doc/public/cairo-sections.txt
@@ -16,6 +16,8 @@ cairo_win32_font_face_create_for_hfont
 cairo_win32_scaled_font_select_font
 cairo_win32_scaled_font_done_font
 cairo_win32_scaled_font_get_metrics_factor
+cairo_win32_scaled_font_get_logical_to_device
+cairo_win32_scaled_font_get_device_to_logical
 </SECTION>
 
 <SECTION>
@@ -66,7 +68,9 @@ cairo_ps_surface_dsc_comment
 <TITLE>Win32 Surfaces</TITLE>
 cairo_win32_surface_create
 cairo_win32_surface_create_with_dib
+cairo_win32_surface_create_with_ddb
 cairo_win32_surface_get_dc
+cairo_win32_surface_get_image
 </SECTION>
 
 <SECTION>
@@ -145,11 +149,17 @@ cairo_version_string
 cairo_pattern_t
 cairo_pattern_add_color_stop_rgb
 cairo_pattern_add_color_stop_rgba
+cairo_pattern_get_color_stop_count
+cairo_pattern_get_color_stop_rgba
 cairo_pattern_create_rgb
 cairo_pattern_create_rgba
+cairo_pattern_get_rgba
 cairo_pattern_create_for_surface
+cairo_pattern_get_surface
 cairo_pattern_create_linear
+cairo_pattern_get_linear_points
 cairo_pattern_create_radial
+cairo_pattern_get_radial_circles
 cairo_pattern_destroy
 cairo_pattern_reference
 cairo_pattern_status
@@ -347,6 +357,8 @@ cairo_antialias_t
 cairo_set_antialias
 cairo_get_antialias
 cairo_set_dash
+cairo_get_dash_count
+cairo_get_dash
 cairo_fill_rule_t
 cairo_set_fill_rule
 cairo_get_fill_rule
@@ -367,7 +379,12 @@ cairo_set_tolerance
 cairo_get_tolerance
 cairo_clip
 cairo_clip_preserve
+cairo_clip_extents
 cairo_reset_clip
+cairo_rectangle_t
+cairo_rectangle_list_t
+cairo_rectangle_list_destroy
+cairo_copy_clip_rectangles
 cairo_fill
 cairo_fill_preserve
 cairo_fill_extents
@@ -450,4 +467,5 @@ cairo_set_target_xcb
 cairo_set_target_drawable
 cairo_get_status_string
 cairo_status_string
+CAIRO_FORMAT_RGB16_565
 </SECTION>
diff-tree 0e028ee0f3bfb95d8483bb4c84b84c4bd53b8c53 (from b8e1f3778e61e3c5a809f610a1af97ea56a9960e)
Author: Behdad Esfahbod <behdad at behdad.org>
Date:   Wed Dec 6 23:40:08 2006 -0500

    [doc/public/Makefile.am] Move the list of private headers generatable
    
    Move the list of private headers into separate file Headers.mk that
    Makefile.am includes (using automake).  To update the list, just remove
    Headers.mk and make.

diff --git a/doc/public/Headers.mk b/doc/public/Headers.mk
new file mode 100644
index 0000000..24e5e21
--- /dev/null
+++ b/doc/public/Headers.mk
@@ -0,0 +1,31 @@
+PRIVATE_TEST_HFILES = \
+	cairo-meta-surface-private.h \
+	cairo-truetype-subset-private.h \
+	cairo-path-data-private.h \
+	cairo-hash-private.h \
+	cairo-cache-private.h \
+	cairo-output-stream-private.h \
+	cairo-arc-private.h \
+	cairo-xlib-test.h \
+	cairo-paginated-surface-private.h \
+	cairo-scaled-font-test.h \
+	cairo-scaled-font-subsets-private.h \
+	cairo-gstate-private.h \
+	cairo-skiplist-private.h \
+	cairo-os2-private.h \
+	cairo-svg-test.h \
+	cairo-freelist-private.h \
+	cairo-glitz-private.h \
+	cairo-ps-test.h \
+	cairo-quartz-private.h \
+	cairo-wideint-private.h \
+	cairo-path-fixed-private.h \
+	cairo-private.h \
+	cairo-ft-private.h \
+	cairo-xlib-private.h \
+	cairo-clip-private.h \
+	cairo-pdf-test.h \
+	cairo-win32-private.h \
+	cairo-analysis-surface-private.h \
+	cairo-surface-fallback-private.h \
+	cairoint.h
diff --git a/doc/public/Makefile.am b/doc/public/Makefile.am
index 026ada2..d9d9cd4 100644
--- a/doc/public/Makefile.am
+++ b/doc/public/Makefile.am
@@ -18,43 +18,32 @@ DOC_SOURCE_DIR=../../src
 HFILE_GLOB=$(top_srcdir)/src/*.h
 CFILE_GLOB=$(top_srcdir)/src/*.c $(top_srcdir)/src/*.h
 
+include $(srcdir)/Headers.mk
+
+UNSUPPORTED_HFILES=		\
+	cairo-atsui.h		\
+	cairo-beos.h		\
+	cairo-directfb.h	\
+	cairo-glitz.h		\
+	cairo-nquartz.h		\
+	cairo-os2.h		\
+	cairo-quartz.h		\
+	cairo-xcb.h		\
+	cairo-xcb-xrender.h
+
 # Headers to ignore
 IGNORE_HFILES=					\
-	cairo-analysis-surface-private.h	\
-	cairo-arc-private.h			\
-	cairo-cache-private.h			\
-	cairo-clip-private.h			\
-	cairo-font-subset-private.h		\
-	cairo-ft-private.h			\
-	cairo-gstate-private.h			\
-	cairo-hash-private.h			\
-	cairo-meta-surface-private.h		\
-	cairo-output-stream-private.h		\
-	cairo-paginated-surface-private.h	\
-	cairo-path-data-private.h		\
-	cairo-path-fixed-private.h		\
-	cairo-private.h				\
-	cairo-quartz-private.h			\
-	cairo-scaled-font-subsets-private.h	\
-	cairo-surface-fallback-private.h	\
-	cairo-wideint-private.h			\
-	cairo-win32-private.h			\
-	cairo-xlib-private.h			\
-	cairo-pdf-test.h			\
-	cairo-ps-test.h				\
-	cairo-scaled-font-test.h		\
-	cairo-svg-test.h			\
-	cairo-truetype-subset-private.h		\
-	cairo-xlib-test.h			\
-	cairoint.h				\
-	cairo-atsui.h				\
-	cairo-beos.h				\
-	cairo-directfb.h			\
-	cairo-glitz.h				\
-	cairo-quartz.h				\
-	cairo-xcb.h				\
-	cairo-xcb-xrender.h
+	$(PRIVATE_TEST_HFILES)			\
+	$(UNSUPPORTED_HFILES)
 
+Headers.mk:
+	( echo "PRIVATE_TEST_HFILES = \\"; \
+	find $(top_srcdir)/src \
+		-name '*-private.h' -o \
+		-name '*-test.h' | \
+	sed 's at .*/@	@; s@$$@ \\@'; \
+	echo '	cairoint.h' ) > $@.tmp
+	mv $@.tmp $@
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 # if $(DOC_MODULE).types is non-empty.
diff-tree b8e1f3778e61e3c5a809f610a1af97ea56a9960e (from fd03991a6a78d849e2184f53a2b1b6915a6a64d0)
Author: Behdad Esfahbod <behdad at behdad.org>
Date:   Wed Dec 6 23:38:20 2006 -0500

    [docs] Document various CAIRO_VERSION_* macros

diff --git a/doc/public/tmpl/cairo-version.sgml b/doc/public/tmpl/cairo-version.sgml
index bc76dce..a06c56a 100644
--- a/doc/public/tmpl/cairo-version.sgml
+++ b/doc/public/tmpl/cairo-version.sgml
@@ -119,28 +119,29 @@ if (cairo_version() >= %CAIRO_VERSION_EN
 
 <!-- ##### MACRO CAIRO_VERSION ##### -->
 <para>
-
+The version of cairo available at compile-time, encoded using
+CAIRO_VERSION_ENCODE().
 </para>
 
 
 
 <!-- ##### MACRO CAIRO_VERSION_MAJOR ##### -->
 <para>
-
+The major component of the version of cairo available at compile-time.
 </para>
 
 
 
 <!-- ##### MACRO CAIRO_VERSION_MINOR ##### -->
 <para>
-
+The minor component of the version of cairo available at compile-time.
 </para>
 
 
 
 <!-- ##### MACRO CAIRO_VERSION_MICRO ##### -->
 <para>
-
+The micro component of the version of cairo available at compile-time.
 </para>
 
 
@@ -154,12 +155,15 @@ if (cairo_version() >= %CAIRO_VERSION_EN
 
 <!-- ##### MACRO CAIRO_VERSION_ENCODE ##### -->
 <para>
-
+This macro encodes the given cairo version into an integer.  The numbers
+returned by %CAIRO_VERSION and pango_version() are encoded using this macro.
+Two encoded version numbers can be compared as integers.  The encoding ensures
+that later versions compare greater than earlier versions.
 </para>
 
- at major: 
- at minor: 
- at micro: 
+ at major: the major component of the version number
+ at minor: the minor component of the version number
+ at micro: the micro component of the version number
 
 
 <!-- ##### FUNCTION cairo_version ##### -->


More information about the cairo-commit mailing list