fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-04-01 02:20:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Add missing sections and symbols for public docs

Browse source 
This adds a number of items to the documentation for which code docs
exist, and also adds sections for cairo-skia and cairo-surface-observer.

Bugzilla: https://bugs.freedesktop.org/show_bug.cgi?id=48784

Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
This commit is contained in:
Bryce Harrington 2014-02-25 13:17:00 -08:00 • committed by Bryce Harrington
parent 4fb5205d2e
commit ac5801792b
3 changed files with 52 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
doc/public/cairo-sections.txt
View file

@ -113,6 +113,15 @@ cairo_recording_surface_ink_extents
cairo_recording_surface_get_extents
</SECTION>
<SECTION>
<FILE>cairo-skia</FILE>
cairo_skia_context
cairo_skia_context_t
cairo_skia_surface
cairo_skia_surface_t
format_to_sk_config
</SECTION>
<SECTION>
<FILE>cairo-win32</FILE>
CAIRO_HAS_WIN32_SURFACE
@ -213,11 +222,21 @@ cairo_device_set_user_data
cairo_device_get_user_data
cairo_device_acquire
cairo_device_release
cairo_device_observer_elapsed
cairo_device_observer_fill_elapsed
cairo_device_observer_glyphs_elapsed
cairo_device_observer_mask_elapsed
cairo_device_observer_paint_elapsed
cairo_device_observer_print
cairo_device_observer_stroke_elapsed
</SECTION>
<SECTION>
<FILE>cairo-surface</FILE>
CAIRO_HAS_MIME_SURFACE
CAIRO_MIME_TYPE_JBIG2
CAIRO_MIME_TYPE_JBIG2_GLOBAL
CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID
CAIRO_MIME_TYPE_JP2
CAIRO_MIME_TYPE_JPEG
CAIRO_MIME_TYPE_PNG
@ -240,6 +259,8 @@ cairo_surface_mark_dirty
cairo_surface_mark_dirty_rectangle
cairo_surface_set_device_offset
cairo_surface_get_device_offset
cairo_surface_get_device_scale
cairo_surface_set_device_scale
cairo_surface_set_fallback_resolution
cairo_surface_get_fallback_resolution
cairo_surface_type_t
@ -257,6 +278,23 @@ cairo_surface_map_to_image
cairo_surface_unmap_image
</SECTION>
<SECTION>
<FILE>cairo-surface-observer</FILE>
CAIRO_HAS_OBSERVER_SURFACE
cairo_surface_create_observer
cairo_surface_observer_add_fill_callback
cairo_surface_observer_add_finish_callback
cairo_surface_observer_add_flush_callback
cairo_surface_observer_add_glyphs_callback
cairo_surface_observer_add_mask_callback
cairo_surface_observer_add_paint_callback
cairo_surface_observer_add_stroke_callback
cairo_surface_observer_callback_t
cairo_surface_observer_elapsed
cairo_surface_observer_mode_t
cairo_surface_observer_print
</SECTION>
<SECTION>
<FILE>cairo-version</FILE>
CAIRO_VERSION

5
src/cairo-surface-observer.c
View file

@ -1368,11 +1368,16 @@ static const cairo_surface_backend_t _cairo_surface_observer_backend = {
/**
* cairo_surface_create_observer:
* @target: an existing surface for which the observer will watch
* @mode: sets the mode of operation (normal vs. record)
*
* Create a new surface that exists solely to watch another is doing. In
* the process it will log operations and times, which are fast, which are
* slow, which are frequent, etc.
*
* The @mode parameter can be set to either CAIRO_SURFACE_OBSERVER_NORMAL
* or CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS, to control whether or not
* the internal observer should record operations.
*
* Return value: a pointer to the newly allocated surface. The caller
* owns the surface and should call cairo_surface_destroy() when done
* with it.

9
src/cairo.h
View file

@ -2208,6 +2208,15 @@ cairo_surface_create_for_rectangle (cairo_surface_t *target,
double width,
double height);
/**
* cairo_surface_observer_mode_t:
* @CAIRO_SURFACE_OBSERVER_NORMAL: no recording is done
* @CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS: operations are recorded
*
* Whether operations should be recorded.
*
* Since: 1.12
**/
typedef enum {
CAIRO_SURFACE_OBSERVER_NORMAL = 0,
CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS = 0x1