Re: [PATCHES] documentation update

From 02b6185394cd18ee6b5402478e0aff5c6748daea Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 11 Mar 2012 00:36:58 +0100
Subject: [PATCH 1/3] add unused symbols to sections doc

---
 doc/public/cairo-sections.txt |   32 +++++++++++++++++++++++++++++++-
 1 files changed, 31 insertions(+), 1 deletions(-)

diff --git a/doc/public/cairo-sections.txt b/doc/public/cairo-sections.txt
index 0af32f0..c67da37 100644
--- a/doc/public/cairo-sections.txt
+++ b/doc/public/cairo-sections.txt
@@ -7,6 +7,10 @@ cairo_ft_font_face_create_for_pattern
 cairo_ft_font_options_substitute
 cairo_ft_scaled_font_lock_face
 cairo_ft_scaled_font_unlock_face
+cairo_ft_synthesize_t
+cairo_ft_font_face_get_synthesize
+cairo_ft_font_face_set_synthesize
+cairo_ft_font_face_unset_synthesize
 </SECTION>
 
 <SECTION>
@@ -106,6 +110,7 @@ cairo_ps_surface_dsc_comment
 CAIRO_HAS_RECORDING_SURFACE
 cairo_recording_surface_create
 cairo_recording_surface_ink_extents
+cairo_recording_surface_get_extents
 </SECTION>
 
 <SECTION>
@@ -117,6 +122,19 @@ cairo_win32_surface_create_with_ddb
 cairo_win32_printing_surface_create
 cairo_win32_surface_get_dc
 cairo_win32_surface_get_image
+<SUBSECTION Private>
+SB_NONE
+SHADEBLENDCAPS
+WIN32_FONT_LOGICAL_SCALE
+cairo_win32_device_t
+cairo_win32_display_surface_t
+cairo_win32_printing_surface_t
+cairo_win32_surface_t
+to_win32_device
+to_win32_device_from_surface
+to_win32_display_surface
+to_win32_printing_surface
+to_win32_surface
 </SECTION>
 
 <SECTION>
@@ -144,6 +162,9 @@ cairo_xlib_surface_get_visual
 cairo_xlib_surface_get_width
 cairo_xlib_surface_get_height
 cairo_xlib_surface_get_depth
+cairo_xlib_device_debug_cap_xrender_version
+cairo_xlib_device_debug_get_precision
+cairo_xlib_device_debug_set_precision
 </SECTION>
 
 <SECTION>
@@ -156,11 +177,17 @@ cairo_xlib_surface_get_xrender_format
 <SECTION>
 <FILE>cairo-xcb</FILE>
 CAIRO_HAS_XCB_SURFACE
+CAIRO_HAS_XCB_SHM_FUNCTIONS
 cairo_xcb_surface_create
 cairo_xcb_surface_create_for_bitmap
 cairo_xcb_surface_create_with_xrender_format
 cairo_xcb_surface_set_size
 cairo_xcb_surface_set_drawable
+cairo_xcb_device_get_connection
+cairo_xcb_device_debug_cap_xrender_version
+cairo_xcb_device_debug_cap_xshm_version
+cairo_xcb_device_debug_get_precision
+cairo_xcb_device_debug_set_precision
 </SECTION>
 
 <SECTION>
@@ -171,7 +198,7 @@ cairo_svg_surface_create_for_stream
 cairo_svg_surface_restrict_to_version
 cairo_svg_version_t
 cairo_svg_get_versions
-cairo_svg_version_to_string 
+cairo_svg_version_to_string
 </SECTION>
 
 <SECTION>
@@ -193,6 +220,7 @@ cairo_device_release
 
 <SECTION>
 <FILE>cairo-surface</FILE>
+CAIRO_HAS_MIME_SURFACE
 CAIRO_MIME_TYPE_JP2
 CAIRO_MIME_TYPE_JPEG
 CAIRO_MIME_TYPE_PNG
@@ -227,6 +255,7 @@ cairo_surface_show_page
 cairo_surface_has_show_text_glyphs
 cairo_surface_set_mime_data
 cairo_surface_get_mime_data
+cairo_surface_supports_mime_type
 cairo_surface_map_to_image
 cairo_surface_unmap_image
 </SECTION>
@@ -654,6 +683,7 @@ cairo_atsui_font_face_create_for_atsu_font_id
 
 <SECTION>
 <FILE>cairo-script</FILE>
+CAIRO_HAS_SCRIPT_SURFACE
 cairo_script_create
 cairo_script_create_for_stream
 cairo_script_from_recording_surface
-- 
1.7.2.5

From bf4cee12baf5f1755192166034c7980a5e1431f1 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Tue, 10 Apr 2012 22:02:54 +0200
Subject: [PATCH 2/3] doc: no separate cairo-xcb-xrender section

There is already a cairo-xcb section and there are no symbols that
should be documented in an extra -xrender section. It is not mentioned
in cairo-sections.txt either. So simply delete it.
---
 src/cairo-xcb-surface-render.c |   13 -------------
 1 files changed, 0 insertions(+), 13 deletions(-)

diff --git a/src/cairo-xcb-surface-render.c b/src/cairo-xcb-surface-render.c
index b1f6ec8..f1f5fbe 100644
--- a/src/cairo-xcb-surface-render.c
+++ b/src/cairo-xcb-surface-render.c
@@ -47,19 +47,6 @@
 
 #define PIXMAN_MAX_INT ((pixman_fixed_1 >> 1) - pixman_fixed_e) /* need to ensure deltas also fit */
 
-/**
- * SECTION:cairo-xcb-xrender
- * @Title: XCB Surfaces
- * @Short_Description: X Window System rendering using the XCB library and the X Render extension
- * @See_Also: #cairo_surface_t
- *
- * The XCB surface is used to render cairo graphics to X Window System
- * windows and pixmaps using the XCB library and its X Render extension.
- *
- * Note that the XCB surface automatically takes advantage of the X Render
- * extension if it is available.
- **/
-
 static cairo_status_t
 _clip_and_composite_boxes (cairo_xcb_surface_t *dst,
 			   cairo_operator_t op,
-- 
1.7.2.5

From 745fdb0da023dd7704ed387fd5d46594f5a1e8c2 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Tue, 10 Apr 2012 22:09:23 +0200
Subject: [PATCH 3/3] doc: add returns statement to cairo_surface_supports_mime_type

---
 src/cairo-surface.c |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/src/cairo-surface.c b/src/cairo-surface.c
index 062c269..4c77de7 100644
--- a/src/cairo-surface.c
+++ b/src/cairo-surface.c
@@ -1224,6 +1224,9 @@ slim_hidden_def (cairo_surface_set_mime_data);
  *
  * Return whether @surface supports @mime_type.
  *
+ * Return value: %TRUE if @surface supports
+ *               @mime_type, %FALSE otherwise
+ *
  * Since: 1.12
  **/
 cairo_bool_t
-- 
1.7.2.5