mirror of
https://gitlab.freedesktop.org/cairo/cairo.git
synced 2026-05-06 08:08:04 +02:00
Add "Since: 1.2" to docs for most new API functions.
This commit is contained in:
parent
bd92eb7f3c
commit
320ce67d63
9 changed files with 72 additions and 12 deletions
|
|
@ -135,6 +135,8 @@ cairo_font_face_destroy (cairo_font_face_t *font_face)
|
|||
* @font_face: a #cairo_font_face_t
|
||||
*
|
||||
* Return value: The type of @font_face. See #cairo_font_type_t.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_font_type_t
|
||||
cairo_font_face_get_type (cairo_font_face_t *font_face)
|
||||
|
|
|
|||
|
|
@ -364,6 +364,8 @@ _cairo_image_surface_create_for_data_with_content (unsigned char *data,
|
|||
*
|
||||
* Return value: a pointer to the image data of this surface or NULL
|
||||
* if @surface is not an image surface.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
unsigned char *
|
||||
cairo_image_surface_get_data (cairo_surface_t *surface)
|
||||
|
|
@ -385,6 +387,8 @@ cairo_image_surface_get_data (cairo_surface_t *surface)
|
|||
* Get the format of the surface.
|
||||
*
|
||||
* Return value: the format of the surface
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_format_t
|
||||
cairo_image_surface_get_format (cairo_surface_t *surface)
|
||||
|
|
@ -451,6 +455,8 @@ cairo_image_surface_get_height (cairo_surface_t *surface)
|
|||
* @surface is not an image surface). The stride is the distance in
|
||||
* bytes from the beginning of one row of the image data to the
|
||||
* beginning of the next row.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
int
|
||||
cairo_image_surface_get_stride (cairo_surface_t *surface)
|
||||
|
|
|
|||
|
|
@ -529,6 +529,8 @@ cairo_pattern_reference (cairo_pattern_t *pattern)
|
|||
* @pattern: a #cairo_pattern_t
|
||||
*
|
||||
* Return value: The type of @pattern. See #cairo_pattern_type_t.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_pattern_type_t
|
||||
cairo_pattern_get_type (cairo_pattern_t *pattern)
|
||||
|
|
|
|||
|
|
@ -320,6 +320,8 @@ _cairo_pdf_surface_create_for_stream_internal (cairo_output_stream_t *output,
|
|||
* This function always returns a valid pointer, but it will return a
|
||||
* pointer to a "nil" surface if an error such as out of memory
|
||||
* occurs. You can use cairo_surface_status() to check for this.
|
||||
*
|
||||
* Since: 1.2
|
||||
*/
|
||||
cairo_surface_t *
|
||||
cairo_pdf_surface_create_for_stream (cairo_write_func_t write,
|
||||
|
|
@ -358,6 +360,8 @@ cairo_pdf_surface_create_for_stream (cairo_write_func_t write,
|
|||
* This function always returns a valid pointer, but it will return a
|
||||
* pointer to a "nil" surface if an error such as out of memory
|
||||
* occurs. You can use cairo_surface_status() to check for this.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_surface_t *
|
||||
cairo_pdf_surface_create (const char *filename,
|
||||
|
|
@ -422,6 +426,8 @@ _extract_pdf_surface (cairo_surface_t *surface,
|
|||
* this is to call this function immediately after creating the
|
||||
* surface or immediately after completing a page with either
|
||||
* cairo_show_page() or cairo_copy_page().
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_pdf_surface_set_size (cairo_surface_t *surface,
|
||||
|
|
|
|||
|
|
@ -748,6 +748,8 @@ _cairo_ps_surface_create_for_stream_internal (cairo_output_stream_t *stream,
|
|||
* This function always returns a valid pointer, but it will return a
|
||||
* pointer to a "nil" surface if an error such as out of memory
|
||||
* occurs. You can use cairo_surface_status() to check for this.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_surface_t *
|
||||
cairo_ps_surface_create (const char *filename,
|
||||
|
|
@ -791,6 +793,8 @@ cairo_ps_surface_create (const char *filename,
|
|||
* This function always returns a valid pointer, but it will return a
|
||||
* pointer to a "nil" surface if an error such as out of memory
|
||||
* occurs. You can use cairo_surface_status() to check for this.
|
||||
*
|
||||
* Since: 1.2
|
||||
*/
|
||||
cairo_surface_t *
|
||||
cairo_ps_surface_create_for_stream (cairo_write_func_t write_func,
|
||||
|
|
@ -856,6 +860,8 @@ _extract_ps_surface (cairo_surface_t *surface,
|
|||
* this is to call this function immediately after creating the
|
||||
* surface or immediately after completing a page with either
|
||||
* cairo_show_page() or cairo_copy_page().
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_ps_surface_set_size (cairo_surface_t *surface,
|
||||
|
|
@ -962,6 +968,8 @@ cairo_ps_surface_set_size (cairo_surface_t *surface,
|
|||
* cairo_ps_surface_dsc_comment (surface, "%%IncludeFeature: *PageSize A5");
|
||||
* ...
|
||||
* </programlisting></informalexample>
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_ps_surface_dsc_comment (cairo_surface_t *surface,
|
||||
|
|
@ -1016,6 +1024,8 @@ cairo_ps_surface_dsc_comment (cairo_surface_t *surface,
|
|||
* and before any drawing is performed to the surface.
|
||||
*
|
||||
* See cairo_ps_surface_dsc_comment() for more details.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_ps_surface_dsc_begin_setup (cairo_surface_t *surface)
|
||||
|
|
@ -1036,7 +1046,7 @@ cairo_ps_surface_dsc_begin_setup (cairo_surface_t *surface)
|
|||
}
|
||||
|
||||
/**
|
||||
* cairo_ps_surface_dsc_begin_setup:
|
||||
* cairo_ps_surface_dsc_begin_page_setup:
|
||||
* @surface: a PostScript cairo_surface_t
|
||||
*
|
||||
* This function indicates that subsequent calls to
|
||||
|
|
@ -1049,6 +1059,8 @@ cairo_ps_surface_dsc_begin_setup (cairo_surface_t *surface)
|
|||
* performed to the surface.
|
||||
*
|
||||
* See cairo_ps_surface_dsc_comment() for more details.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_ps_surface_dsc_begin_page_setup (cairo_surface_t *surface)
|
||||
|
|
|
|||
|
|
@ -124,6 +124,8 @@ _cairo_scaled_font_set_error (cairo_scaled_font_t *scaled_font,
|
|||
* @scaled_font: a #cairo_scaled_font_t
|
||||
*
|
||||
* Return value: The type of @scaled_font. See #cairo_font_type_t.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_font_type_t
|
||||
cairo_scaled_font_get_type (cairo_scaled_font_t *scaled_font)
|
||||
|
|
@ -643,6 +645,8 @@ cairo_scaled_font_extents (cairo_scaled_font_t *scaled_font,
|
|||
* characters. In particular, trailing whitespace characters are
|
||||
* likely to not affect the size of the rectangle, though they will
|
||||
* affect the x_advance and y_advance values.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_scaled_font_text_extents (cairo_scaled_font_t *scaled_font,
|
||||
|
|
@ -1296,6 +1300,8 @@ _cairo_scaled_glyph_lookup (cairo_scaled_font_t *scaled_font,
|
|||
*
|
||||
* Return value: The #cairo_font_face_t with which @scaled_font was
|
||||
* created.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_font_face_t *
|
||||
cairo_scaled_font_get_font_face (cairo_scaled_font_t *scaled_font)
|
||||
|
|
@ -1313,6 +1319,8 @@ cairo_scaled_font_get_font_face (cairo_scaled_font_t *scaled_font)
|
|||
*
|
||||
* Stores the font matrix with which @scaled_font was created into
|
||||
* @matrix.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_scaled_font_get_font_matrix (cairo_scaled_font_t *scaled_font,
|
||||
|
|
@ -1332,6 +1340,8 @@ cairo_scaled_font_get_font_matrix (cairo_scaled_font_t *scaled_font,
|
|||
* @ctm: return value for the CTM
|
||||
*
|
||||
* Stores the CTM with which @scaled_font was created into @ctm.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_scaled_font_get_ctm (cairo_scaled_font_t *scaled_font,
|
||||
|
|
@ -1352,6 +1362,8 @@ cairo_scaled_font_get_ctm (cairo_scaled_font_t *scaled_font,
|
|||
*
|
||||
* Stores the font options with which @scaled_font was created into
|
||||
* @ctm.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_scaled_font_get_font_options (cairo_scaled_font_t *scaled_font,
|
||||
|
|
|
|||
|
|
@ -158,6 +158,8 @@ _cairo_surface_set_error (cairo_surface_t *surface,
|
|||
* @surface: a #cairo_surface_t
|
||||
*
|
||||
* Return value: The type of @surface. See #cairo_surface_type_t.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_surface_type_t
|
||||
cairo_surface_get_type (cairo_surface_t *surface)
|
||||
|
|
@ -176,6 +178,8 @@ cairo_surface_get_type (cairo_surface_t *surface)
|
|||
* Return value: The content type of @surface which indicates whether
|
||||
* the surface contains color and/or alpha information. See
|
||||
* #cairo_content_t.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_content_t
|
||||
cairo_surface_get_content (cairo_surface_t *surface)
|
||||
|
|
@ -718,6 +722,7 @@ cairo_surface_set_device_offset (cairo_surface_t *surface,
|
|||
* Returns a previous device offset set by
|
||||
* cairo_surface_set_device_offset().
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_surface_get_device_offset (cairo_surface_t *surface,
|
||||
|
|
@ -755,6 +760,8 @@ cairo_surface_get_device_offset (cairo_surface_t *surface,
|
|||
* completing a page (with cairo_show_page() or cairo_copy_page()) so
|
||||
* there is currently no way to have more than one fallback resolution
|
||||
* in effect on a single page.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_surface_set_fallback_resolution (cairo_surface_t *surface,
|
||||
|
|
@ -764,13 +771,6 @@ cairo_surface_set_fallback_resolution (cairo_surface_t *surface,
|
|||
surface->x_fallback_resolution = x_pixels_per_inch;
|
||||
surface->y_fallback_resolution = y_pixels_per_inch;
|
||||
}
|
||||
/* XXX: Add symbols for old, deprecated names to eas GTK+ migration
|
||||
* pain. This is a transition strategy for prior to 1.2. These
|
||||
* aliases should be dropped before the major release.
|
||||
*/
|
||||
CAIRO_FUNCTION_ALIAS(cairo_pdf_surface_set_dpi, cairo_surface_set_fallback_resolution);
|
||||
CAIRO_FUNCTION_ALIAS(cairo_ps_surface_set_dpi, cairo_surface_set_fallback_resolution);
|
||||
CAIRO_FUNCTION_ALIAS(cairo_svg_surface_set_dpi, cairo_surface_set_fallback_resolution);
|
||||
|
||||
cairo_bool_t
|
||||
_cairo_surface_has_device_transform (cairo_surface_t *surface)
|
||||
|
|
|
|||
|
|
@ -171,6 +171,8 @@ static const cairo_paginated_surface_backend_t cairo_svg_surface_paginated_backe
|
|||
* This function always returns a valid pointer, but it will return a
|
||||
* pointer to a "nil" surface if an error such as out of memory
|
||||
* occurs. You can use cairo_surface_status() to check for this.
|
||||
*
|
||||
* Since: 1.2
|
||||
*/
|
||||
cairo_surface_t *
|
||||
cairo_svg_surface_create_for_stream (cairo_write_func_t write,
|
||||
|
|
@ -207,8 +209,9 @@ cairo_svg_surface_create_for_stream (cairo_write_func_t write,
|
|||
* This function always returns a valid pointer, but it will return a
|
||||
* pointer to a "nil" surface if an error such as out of memory
|
||||
* occurs. You can use cairo_surface_status() to check for this.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
|
||||
cairo_surface_t *
|
||||
cairo_svg_surface_create (const char *filename,
|
||||
double width,
|
||||
|
|
@ -268,8 +271,9 @@ _extract_svg_surface (cairo_surface_t *surface,
|
|||
* have been performed on the given surface. The simplest way to do
|
||||
* this is to call this function immediately after creating the
|
||||
* surface.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
|
||||
void
|
||||
cairo_svg_surface_restrict_to_version (cairo_surface_t *abstract_surface,
|
||||
cairo_svg_version_t version)
|
||||
|
|
@ -295,8 +299,9 @@ cairo_svg_surface_restrict_to_version (cairo_surface_t *abstract_surface,
|
|||
*
|
||||
* Returns the list of supported versions. See
|
||||
* cairo_svg_surface_restrict_to_version().
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
|
||||
void
|
||||
cairo_svg_get_versions (cairo_svg_version_t const **versions,
|
||||
int *num_versions)
|
||||
|
|
@ -315,8 +320,9 @@ cairo_svg_get_versions (cairo_svg_version_t const **versions,
|
|||
* Returns the string associated to given @version. This function
|
||||
* will return NULL if @version isn't valid. See cairo_svg_get_versions()
|
||||
* for a way to get the list of valid version ids.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
|
||||
const char *
|
||||
cairo_svg_version_to_string (cairo_svg_version_t version)
|
||||
{
|
||||
|
|
|
|||
14
src/cairo.c
14
src/cairo.c
|
|
@ -371,6 +371,8 @@ slim_hidden_def(cairo_restore);
|
|||
* cairo_pop_group_to_source (cr);
|
||||
* cairo_paint_with_alpha (cr, alpha);
|
||||
* </programlisting></informalexample>
|
||||
*
|
||||
* Since: 1.2
|
||||
*/
|
||||
void
|
||||
cairo_push_group (cairo_t *cr)
|
||||
|
|
@ -395,6 +397,8 @@ slim_hidden_def(cairo_push_group);
|
|||
* control this content type is the only distinction between this
|
||||
* function and cairo_push_group() which you should see for a more
|
||||
* detailed description of group rendering.
|
||||
*
|
||||
* Since: 1.2
|
||||
*/
|
||||
void
|
||||
cairo_push_group_with_content (cairo_t *cr, cairo_content_t content)
|
||||
|
|
@ -458,6 +462,8 @@ slim_hidden_def(cairo_push_group_with_content);
|
|||
* results of all drawing operations performed to the group. The
|
||||
* caller owns the returned object and should call
|
||||
* cairo_pattern_destroy() when finished with it.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_pattern_t *
|
||||
cairo_pop_group (cairo_t *cr)
|
||||
|
|
@ -525,6 +531,8 @@ slim_hidden_def(cairo_pop_group);
|
|||
* call to cairo_save() by the push_group function), so that any
|
||||
* changes to the graphics state will not be visible outside the
|
||||
* group.
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_pop_group_to_source (cairo_t *cr)
|
||||
|
|
@ -1219,6 +1227,8 @@ slim_hidden_def(cairo_move_to);
|
|||
* makes things easier as it is no longer necessary to manually
|
||||
* compute the arc's initial coordinates for a call to
|
||||
* cairo_move_to().
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_new_sub_path (cairo_t *cr)
|
||||
|
|
@ -2264,6 +2274,8 @@ cairo_get_font_options (cairo_t *cr,
|
|||
* some translation, the current CTM of the #cairo_t should be the
|
||||
* same as that of the #cairo_scaled_font_t, which can be accessed
|
||||
* using cairo_scaled_font_get_ctm().
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
void
|
||||
cairo_set_scaled_font (cairo_t *cr,
|
||||
|
|
@ -2736,6 +2748,8 @@ cairo_get_target (cairo_t *cr)
|
|||
* Return value: the target group surface, or NULL if none. This
|
||||
* object is owned by cairo. To keep a reference to it, you must call
|
||||
* cairo_surface_reference().
|
||||
*
|
||||
* Since: 1.2
|
||||
**/
|
||||
cairo_surface_t *
|
||||
cairo_get_group_target (cairo_t *cr)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue