summaryrefslogtreecommitdiff
path: root/src/cairo-device.c
diff options
context:
space:
mode:
authorM Joonas Pihlaja <jpihlaja@cc.helsinki.fi>2010-08-29 00:05:51 +0300
committerM Joonas Pihlaja <jpihlaja@cc.helsinki.fi>2010-08-29 00:05:51 +0300
commit9f98ec6eb915204d59820cf57d32f347f9933517 (patch)
tree89153d859d7f0d67c5a96f9d7cc39fc78bd83f4d /src/cairo-device.c
parentb0f65054b810d432238ff4986bee3f63e1fc46df (diff)
downloadcairo-9f98ec6eb915204d59820cf57d32f347f9933517.tar.gz
device: Refer the user to per-backend docs about devices.
The exact semantics of the device API can't be spelled out out in the device API docs since the effects are so tied to the specific backend. To use a particular device in practice the user should refer to the backend docs.
Diffstat (limited to 'src/cairo-device.c')
-rw-r--r--src/cairo-device.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/cairo-device.c b/src/cairo-device.c
index dac1b3b6b..15b048477 100644
--- a/src/cairo-device.c
+++ b/src/cairo-device.c
@@ -86,6 +86,12 @@
* cairo_device_release (device);
* }
* </programlisting></informalexample>
+ *
+ * <note><para>Please refer to the documentation of each backend for
+ * additional usage requirements, guarantees provided, and
+ * interactions with existing surface API of the device functions for
+ * surfaces of that type.
+ * </para></note>
*/
static const cairo_device_t _nil_device = {