summaryrefslogtreecommitdiff
path: root/src/cairo-font-options.c
diff options
context:
space:
mode:
authorBenjamin Otte <otte@redhat.com>2010-07-08 13:05:18 +0200
committerBenjamin Otte <otte@redhat.com>2010-07-08 14:27:16 +0200
commitb870cc030d8e0eb6309695e5a101c802f688cf40 (patch)
tree943381b08e5af5a8053d043b1465c0b2340e50a4 /src/cairo-font-options.c
parent65a1e351330106ee0af9f6f0df06b82954341ee6 (diff)
downloadcairo-b870cc030d8e0eb6309695e5a101c802f688cf40.tar.gz
doc: Move tmpl/ docs to inline docs
I did this manually so I could review the docs at the same time. If anyone finds typos or other mistakes I did, please complain to me (or better: fix them).
Diffstat (limited to 'src/cairo-font-options.c')
-rw-r--r--src/cairo-font-options.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/cairo-font-options.c b/src/cairo-font-options.c
index 971f7d50d..b472a3014 100644
--- a/src/cairo-font-options.c
+++ b/src/cairo-font-options.c
@@ -37,6 +37,18 @@
#include "cairoint.h"
#include "cairo-error-private.h"
+/**
+ * SECTION:cairo-font-options
+ * @Title: cairo_font_options_t
+ * @Short_Description: How a font should be rendered
+ * @See_Also: #cairo_scaled_font_t
+ *
+ * The font options specify how fonts should be rendered. Most of the
+ * time the font options implied by a surface are just right and do not
+ * need any changes, but for pixel-based targets tweaking font options
+ * may result in superior output on a particular display.
+ */
+
static const cairo_font_options_t _cairo_font_options_nil = {
CAIRO_ANTIALIAS_DEFAULT,
CAIRO_SUBPIXEL_ORDER_DEFAULT,