From 17a5c3a3daef92ee1702edd4ca007590d5606ae6 Mon Sep 17 00:00:00 2001 From: Carl Worth Date: Tue, 24 May 2005 16:08:39 +0000 Subject: Re-synch with latest from gtk-doc CVS tree. Add --only-section-tmpl option so that changes to inline documentation does not lead to churn in the .sgml template files. Commit new templates now that gtk-doc has ripped all the inline portions out. New template files added for new sections. Update to match current API. Make parameter names match those in the .c file and its documentation. --- doc/public/Makefile.am | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/public/Makefile.am') diff --git a/doc/public/Makefile.am b/doc/public/Makefile.am index f058d36aa..9d89a38d9 100644 --- a/doc/public/Makefile.am +++ b/doc/public/Makefile.am @@ -38,6 +38,9 @@ GTKDOC_LIBS = # Extra options to supply to gtkdoc-mkdb MKDB_OPTIONS=--sgml-mode --output-format=xml +# Extra options to supply to gtkdoc-mktmpl +MKTMPL_OPTIONS=--only-section-tmpl + # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) content_files = \ language-bindings.xml -- cgit v1.2.3 From 615d50976735a544da6888dc608495d130878400 Mon Sep 17 00:00:00 2001 From: Owen Taylor Date: Wed, 15 Jun 2005 16:04:19 +0000 Subject: Remove --only-section-tmpl; it doesn't really work currently :-(. --- ChangeLog | 5 + doc/public/Makefile.am | 2 +- doc/public/tmpl/cairo-font.sgml | 121 ++++ doc/public/tmpl/cairo-ft.sgml | 36 ++ doc/public/tmpl/cairo-glitz.sgml | 9 + doc/public/tmpl/cairo-matrix.sgml | 131 ++++ doc/public/tmpl/cairo-pattern.sgml | 154 +++++ doc/public/tmpl/cairo-pdf.sgml | 33 + doc/public/tmpl/cairo-png.sgml | 40 ++ doc/public/tmpl/cairo-ps.sgml | 33 + doc/public/tmpl/cairo-quartz.sgml | 11 + doc/public/tmpl/cairo-surface.sgml | 75 +++ doc/public/tmpl/cairo-win32.sgml | 45 ++ doc/public/tmpl/cairo-xcb-xrender.sgml | 13 + doc/public/tmpl/cairo-xcb.sgml | 35 ++ doc/public/tmpl/cairo-xlib-xrender.sgml | 13 + doc/public/tmpl/cairo-xlib.sgml | 35 ++ doc/public/tmpl/cairo.sgml | 1039 +++++++++++++++++++++++++++++++ src/cairo-ft-font.c | 2 +- src/cairo-win32-font.c | 2 +- 20 files changed, 1831 insertions(+), 3 deletions(-) (limited to 'doc/public/Makefile.am') diff --git a/ChangeLog b/ChangeLog index bd90b6b29..2f7311bf2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2005-06-15 Owen Taylor + + * doc/public/Makefile.am (MKTMPL_OPTIONS): Remove --only-section-tmpl; + it doesn't really work currently :-(. + 2005-06-15 Owen Taylor * src/cairo-gstate.c (_cairo_gstate_clip_and_composite_trapezoids): diff --git a/doc/public/Makefile.am b/doc/public/Makefile.am index 9d89a38d9..9e4c10365 100644 --- a/doc/public/Makefile.am +++ b/doc/public/Makefile.am @@ -39,7 +39,7 @@ GTKDOC_LIBS = MKDB_OPTIONS=--sgml-mode --output-format=xml # Extra options to supply to gtkdoc-mktmpl -MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) content_files = \ diff --git a/doc/public/tmpl/cairo-font.sgml b/doc/public/tmpl/cairo-font.sgml index d6b4f57a5..d6c7043d2 100644 --- a/doc/public/tmpl/cairo-font.sgml +++ b/doc/public/tmpl/cairo-font.sgml @@ -17,3 +17,124 @@ Font Handling + + + + + + + + + + + + + + + + + +@font_face: + + + + + + + +@font_face: + + + + + + + +@font_face: +@key: +@Returns: + + + + + + + +@font_face: +@key: +@user_data: +@destroy: +@Returns: + + + + + + + +@font_face: +@font_matrix: +@ctm: +@Returns: + + + + + + + +@scaled_font: + + + + + + + +@scaled_font: + + + + + + + +@ascent: +@descent: +@height: +@max_x_advance: +@max_y_advance: + + + + + + +@scaled_font: +@extents: +@Returns: + + + + + + + +@x_bearing: +@y_bearing: +@width: +@height: +@x_advance: +@y_advance: + + + + + + +@scaled_font: +@glyphs: +@num_glyphs: +@extents: + + diff --git a/doc/public/tmpl/cairo-ft.sgml b/doc/public/tmpl/cairo-ft.sgml index ab266985b..d9f7cbfc1 100644 --- a/doc/public/tmpl/cairo-ft.sgml +++ b/doc/public/tmpl/cairo-ft.sgml @@ -17,3 +17,39 @@ FreeType Fonts + + + + + +@pattern: +@Returns: + + + + + + + +@face: +@load_flags: +@Returns: + + + + + + + +@scaled_font: +@Returns: + + + + + + + +@scaled_font: + + diff --git a/doc/public/tmpl/cairo-glitz.sgml b/doc/public/tmpl/cairo-glitz.sgml index c90099697..9594d87a5 100644 --- a/doc/public/tmpl/cairo-glitz.sgml +++ b/doc/public/tmpl/cairo-glitz.sgml @@ -17,3 +17,12 @@ Glitz backend + + + + + +@surface: +@Returns: + + diff --git a/doc/public/tmpl/cairo-matrix.sgml b/doc/public/tmpl/cairo-matrix.sgml index 0fdb254aa..d9549b4a6 100644 --- a/doc/public/tmpl/cairo-matrix.sgml +++ b/doc/public/tmpl/cairo-matrix.sgml @@ -41,3 +41,134 @@ cairo_matrix_t + + + + + +@xx: +@yx: +@xy: +@yy: +@x0: +@y0: + + + + + + +@matrix: +@xx: +@yx: +@xy: +@yy: +@x0: +@y0: + + + + + + + +@matrix: + + + + + + + +@matrix: +@tx: +@ty: + + + + + + + +@matrix: +@sx: +@sy: + + + + + + + +@matrix: +@radians: + + + + + + + +@matrix: +@tx: +@ty: + + + + + + + +@matrix: +@sx: +@sy: + + + + + + + +@matrix: +@radians: + + + + + + + +@matrix: +@Returns: + + + + + + + +@result: +@a: +@b: + + + + + + + +@matrix: +@dx: +@dy: + + + + + + + +@matrix: +@x: +@y: + + diff --git a/doc/public/tmpl/cairo-pattern.sgml b/doc/public/tmpl/cairo-pattern.sgml index 3ea109264..82f3e4dc0 100644 --- a/doc/public/tmpl/cairo-pattern.sgml +++ b/doc/public/tmpl/cairo-pattern.sgml @@ -17,3 +17,157 @@ cairo_pattern_t + + + + + + + + + + + +@surface: +@Returns: + + + + + + + +@x0: +@y0: +@x1: +@y1: +@Returns: + + + + + + + +@cx0: +@cy0: +@radius0: +@cx1: +@cy1: +@radius1: +@Returns: + + + + + + + +@pattern: + + + + + + + +@pattern: + + + + + + + +@pattern: +@Returns: + + + + + + + +@pattern: +@offset: +@red: +@green: +@blue: + + + + + + + +@pattern: +@offset: +@red: +@green: +@blue: +@alpha: + + + + + + + +@pattern: +@matrix: + + + + + + + +@pattern: +@matrix: + + + + + + + +@CAIRO_EXTEND_NONE: +@CAIRO_EXTEND_REPEAT: +@CAIRO_EXTEND_REFLECT: + + + + + + +@pattern: +@extend: + + + + + + + +@pattern: +@Returns: + + + + + + + +@pattern: +@filter: + + + + + + + +@pattern: +@Returns: + + diff --git a/doc/public/tmpl/cairo-pdf.sgml b/doc/public/tmpl/cairo-pdf.sgml index 2cfcdb6b6..d29ed0e26 100644 --- a/doc/public/tmpl/cairo-pdf.sgml +++ b/doc/public/tmpl/cairo-pdf.sgml @@ -17,3 +17,36 @@ PDF Backend + + + + + +@filename: +@width_in_points: +@height_in_points: +@Returns: + + + + + + + +@write_func: +@closure: +@width_in_points: +@height_in_points: +@Returns: + + + + + + + +@surface: +@x_dpi: +@y_dpi: + + diff --git a/doc/public/tmpl/cairo-png.sgml b/doc/public/tmpl/cairo-png.sgml index 8aad228fc..dd4486c71 100644 --- a/doc/public/tmpl/cairo-png.sgml +++ b/doc/public/tmpl/cairo-png.sgml @@ -17,3 +17,43 @@ PNG Backend + + + + + +@filename: +@Returns: + + + + + + + +@read_func: +@closure: +@Returns: + + + + + + + +@surface: +@filename: +@Returns: + + + + + + + +@surface: +@write_func: +@closure: +@Returns: + + diff --git a/doc/public/tmpl/cairo-ps.sgml b/doc/public/tmpl/cairo-ps.sgml index f29c50833..4c5e8b37b 100644 --- a/doc/public/tmpl/cairo-ps.sgml +++ b/doc/public/tmpl/cairo-ps.sgml @@ -17,3 +17,36 @@ PS Backend + + + + + +@filename: +@width_in_points: +@height_in_points: +@Returns: + + + + + + + +@write_func: +@closure: +@width_in_points: +@height_in_points: +@Returns: + + + + + + + +@surface: +@x_dpi: +@y_dpi: + + diff --git a/doc/public/tmpl/cairo-quartz.sgml b/doc/public/tmpl/cairo-quartz.sgml index 6bccb6cc4..c83de6c77 100644 --- a/doc/public/tmpl/cairo-quartz.sgml +++ b/doc/public/tmpl/cairo-quartz.sgml @@ -17,3 +17,14 @@ Quartz Backend + + + + + +@context: +@width: +@height: +@Returns: + + diff --git a/doc/public/tmpl/cairo-surface.sgml b/doc/public/tmpl/cairo-surface.sgml index 35f33a31a..fab1306f6 100644 --- a/doc/public/tmpl/cairo-surface.sgml +++ b/doc/public/tmpl/cairo-surface.sgml @@ -17,3 +17,78 @@ cairo_surface_t + + + + + + + + + + + +@other: +@format: +@width: +@height: +@Returns: + + + + + + + +@surface: + + + + + + + +@surface: + + + + + + + +@surface: +@Returns: + + + + + + + +@surface: +@key: +@user_data: +@destroy: +@Returns: + + + + + + + +@surface: +@key: +@Returns: + + + + + + + +@surface: +@x_offset: +@y_offset: + + diff --git a/doc/public/tmpl/cairo-win32.sgml b/doc/public/tmpl/cairo-win32.sgml index 0811de207..4976ea064 100644 --- a/doc/public/tmpl/cairo-win32.sgml +++ b/doc/public/tmpl/cairo-win32.sgml @@ -17,3 +17,48 @@ Microsoft Windows Backend + + + + + +@hdc: +@Returns: + + + + + + + +@logfont: +@Returns: + + + + + + + +@scaled_font: +@hdc: +@Returns: + + + + + + + +@scaled_font: + + + + + + + +@scaled_font: +@Returns: + + diff --git a/doc/public/tmpl/cairo-xcb-xrender.sgml b/doc/public/tmpl/cairo-xcb-xrender.sgml index 47b5c2d9f..892967ec0 100644 --- a/doc/public/tmpl/cairo-xcb-xrender.sgml +++ b/doc/public/tmpl/cairo-xcb-xrender.sgml @@ -17,3 +17,16 @@ XCB Backend + + + + + +@c: +@drawable: +@format: +@width: +@height: +@Returns: + + diff --git a/doc/public/tmpl/cairo-xcb.sgml b/doc/public/tmpl/cairo-xcb.sgml index 47b5c2d9f..a58912c75 100644 --- a/doc/public/tmpl/cairo-xcb.sgml +++ b/doc/public/tmpl/cairo-xcb.sgml @@ -17,3 +17,38 @@ XCB Backend + + + + + +@c: +@drawable: +@visual: +@width: +@height: +@Returns: + + + + + + + +@c: +@bitmap: +@width: +@height: +@Returns: + + + + + + + +@surface: +@width: +@height: + + diff --git a/doc/public/tmpl/cairo-xlib-xrender.sgml b/doc/public/tmpl/cairo-xlib-xrender.sgml index c99d78407..4ceab1968 100644 --- a/doc/public/tmpl/cairo-xlib-xrender.sgml +++ b/doc/public/tmpl/cairo-xlib-xrender.sgml @@ -17,3 +17,16 @@ XLib/Xrender Backend + + + + + +@dpy: +@drawable: +@format: +@width: +@height: +@Returns: + + diff --git a/doc/public/tmpl/cairo-xlib.sgml b/doc/public/tmpl/cairo-xlib.sgml index 887077a76..ae8bb785c 100644 --- a/doc/public/tmpl/cairo-xlib.sgml +++ b/doc/public/tmpl/cairo-xlib.sgml @@ -17,3 +17,38 @@ XLib Backend + + + + + +@dpy: +@drawable: +@visual: +@width: +@height: +@Returns: + + + + + + + +@dpy: +@bitmap: +@width: +@height: +@Returns: + + + + + + + +@surface: +@width: +@height: + + diff --git a/doc/public/tmpl/cairo.sgml b/doc/public/tmpl/cairo.sgml index 6400638fe..ac9211794 100644 --- a/doc/public/tmpl/cairo.sgml +++ b/doc/public/tmpl/cairo.sgml @@ -27,3 +27,1042 @@ Drawing contexts. + + + + + + + + + + + +@target: +@Returns: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@CAIRO_FORMAT_ARGB32: +@CAIRO_FORMAT_RGB24: +@CAIRO_FORMAT_A8: +@CAIRO_FORMAT_A1: + + + + + + +@CAIRO_OPERATOR_CLEAR: +@CAIRO_OPERATOR_SOURCE: +@CAIRO_OPERATOR_OVER: +@CAIRO_OPERATOR_IN: +@CAIRO_OPERATOR_OUT: +@CAIRO_OPERATOR_ATOP: +@CAIRO_OPERATOR_DEST: +@CAIRO_OPERATOR_DEST_OVER: +@CAIRO_OPERATOR_DEST_IN: +@CAIRO_OPERATOR_DEST_OUT: +@CAIRO_OPERATOR_DEST_ATOP: +@CAIRO_OPERATOR_XOR: +@CAIRO_OPERATOR_ADD: +@CAIRO_OPERATOR_SATURATE: + + + + + + +@cr: +@op: + + + + + + + +@cr: +@red: +@green: +@blue: + + + + + + + +@cr: +@red: +@green: +@blue: +@alpha: + + + + + + + +@cr: +@source: + + + + + + + +@cr: +@surface: +@x: +@y: + + + + + + + +@cr: +@tolerance: + + + + + + + +@CAIRO_FILL_RULE_WINDING: +@CAIRO_FILL_RULE_EVEN_ODD: + + + + + + +@cr: +@fill_rule: + + + + + + + +@cr: +@width: + + + + + + + +@CAIRO_LINE_CAP_BUTT: +@CAIRO_LINE_CAP_ROUND: +@CAIRO_LINE_CAP_SQUARE: + + + + + + +@cr: +@line_cap: + + + + + + + +@CAIRO_LINE_JOIN_MITER: +@CAIRO_LINE_JOIN_ROUND: +@CAIRO_LINE_JOIN_BEVEL: + + + + + + +@cr: +@line_join: + + + + + + + +@cr: +@dashes: +@ndash: +@offset: + + + + + + + +@cr: +@limit: + + + + + + + +@cr: +@tx: +@ty: + + + + + + + +@cr: +@sx: +@sy: + + + + + + + +@cr: +@angle: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@dx: +@dy: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@dx: +@dy: + + + + + + + +@cr: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@x1: +@y1: +@x2: +@y2: +@x3: +@y3: + + + + + + + +@cr: +@xc: +@yc: +@radius: +@angle1: +@angle2: + + + + + + + +@cr: +@xc: +@yc: +@radius: +@angle1: +@angle2: + + + + + + + +@cr: +@dx: +@dy: + + + + + + + +@cr: +@dx: +@dy: + + + + + + + +@cr: +@dx1: +@dy1: +@dx2: +@dy2: +@dx3: +@dy3: + + + + + + + +@cr: +@x: +@y: +@width: +@height: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: +@alpha: + + + + + + + +@cr: +@pattern: + + + + + + + +@cr: +@surface: +@surface_x: +@surface_y: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: +@x: +@y: +@Returns: + + + + + + + +@cr: +@x: +@y: +@Returns: + + + + + + + + + + + + + +@cr: +@x1: +@y1: +@x2: +@y2: + + + + + + + +@cr: +@x1: +@y1: +@x2: +@y2: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@index: +@x: +@y: + + + + + + +@CAIRO_FONT_SLANT_NORMAL: +@CAIRO_FONT_SLANT_ITALIC: +@CAIRO_FONT_SLANT_OBLIQUE: + + + + + + +@CAIRO_FONT_WEIGHT_NORMAL: +@CAIRO_FONT_WEIGHT_BOLD: + + + + + + +@cr: +@family: +@slant: +@weight: + + + + + + + +@cr: +@size: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: +@utf8: + + + + + + + +@cr: +@glyphs: +@num_glyphs: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@extents: + + + + + + + +@cr: +@font_face: + + + + + + + +@cr: +@utf8: +@extents: + + + + + + + +@cr: +@glyphs: +@num_glyphs: +@extents: + + + + + + + +@cr: +@utf8: + + + + + + + +@cr: +@glyphs: +@num_glyphs: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@path: + + + + + + + +@CAIRO_PATH_MOVE_TO: +@CAIRO_PATH_LINE_TO: +@CAIRO_PATH_CURVE_TO: +@CAIRO_PATH_CLOSE_PATH: + + + + + + +@status: +@data: +@num_data: + + + + + + +@path: + + + + + + + +@CAIRO_STATUS_SUCCESS: +@CAIRO_STATUS_NO_MEMORY: +@CAIRO_STATUS_INVALID_RESTORE: +@CAIRO_STATUS_INVALID_POP_GROUP: +@CAIRO_STATUS_NO_CURRENT_POINT: +@CAIRO_STATUS_INVALID_MATRIX: +@CAIRO_STATUS_NO_TARGET_SURFACE: +@CAIRO_STATUS_NULL_POINTER: +@CAIRO_STATUS_INVALID_STRING: +@CAIRO_STATUS_INVALID_PATH_DATA: +@CAIRO_STATUS_READ_ERROR: +@CAIRO_STATUS_WRITE_ERROR: +@CAIRO_STATUS_SURFACE_FINISHED: +@CAIRO_STATUS_SURFACE_TYPE_MISMATCH: +@CAIRO_STATUS_PATTERN_TYPE_MISMATCH: + + + + + + +@cr: +@Returns: + + + + + + + + + + + + + + +@status: +@Returns: + + + + + + + +@CAIRO_FILTER_FAST: +@CAIRO_FILTER_GOOD: +@CAIRO_FILTER_BEST: +@CAIRO_FILTER_NEAREST: +@CAIRO_FILTER_BILINEAR: +@CAIRO_FILTER_GAUSSIAN: + + + + + + +@format: +@width: +@height: +@Returns: + + + + + + + +@data: +@format: +@width: +@height: +@stride: +@Returns: + + + + + + + +@surface: +@Returns: + + + + + + + +@surface: +@Returns: + + + + + + + +@data: + + + + + + + +@unused: + + + + + + +@closure: +@data: +@length: +@Returns: + + + + + + + +@closure: +@data: +@length: +@Returns: + + diff --git a/src/cairo-ft-font.c b/src/cairo-ft-font.c index d61e7875f..63f51a51c 100644 --- a/src/cairo-ft-font.c +++ b/src/cairo-ft-font.c @@ -1482,7 +1482,7 @@ cairo_ft_font_face_create_for_pattern (FcPattern *pattern) } /** - * cairo_ft_font_create_for_ft_face: + * cairo_ft_font_face_create_for_ft_face: * @face: A FreeType face object, already opened. This must * be kept around until the face's refcount drops to * zero and it is freed. Since the face may be referenced diff --git a/src/cairo-win32-font.c b/src/cairo-win32-font.c index 22e3dab5b..eef2b4e72 100644 --- a/src/cairo-win32-font.c +++ b/src/cairo-win32-font.c @@ -1160,7 +1160,7 @@ static const cairo_font_face_backend_t _cairo_win32_font_face_backend = { }; /** - * cairo_win32_scaled_font_create_for_logfontw: + * cairo_win32_font_face_create_for_logfontw: * @logfont: A #LOGFONTW structure specifying the font to use. * The lfHeight, lfWidth, lfOrientation and lfEscapement * fields of this structure are ignored. -- cgit v1.2.3