Surface docs: Use cairomm names where possible

such as Cairo::ScaledFont::create() instead of cairo_scaled_font_create().

1 files changed, 16 insertions, 14 deletions

diff --git a/cairomm/surface.h b/cairomm/surface.h
index 079bd3b..18b1bca 100644
--- a/cairomm/surface.h
+++ b/cairomm/surface.h
@@ -362,7 +362,7 @@ public:
   /** Retrieves the default font rendering options for the surface. This allows
    * display surfaces to report the correct subpixel order for rendering on
    * them, print surfaces to disable hinting of metrics and so forth. The
-   * result can then be used with cairo_scaled_font_create().
+   * result can then be used with Cairo::ScaledFont::create().
    *
    * @param options 	a FontOptions object into which to store the retrieved
    * options. All existing values are overwritten
@@ -413,10 +413,10 @@ public:
 
   /** Sets an offset that is added to the device coordinates determined by the
    * CTM when drawing to surface. One use case for this function is when we
-   * want to create a Surface that redirects drawing for a portion of
+   * want to create a %Surface that redirects drawing for a portion of
    * an onscreen surface to an offscreen surface in a way that is completely
    * invisible to the user of the cairo API. Setting a transformation via
-   * cairo_translate() isn't sufficient to do this, since functions like
+   * Cairo::Context::translate() isn't sufficient to do this, since functions like
    * Cairo::Context::device_to_user() will expose the hidden offset.
    *
    * Note that the offset only affects drawing to the surface, not using the
@@ -651,17 +651,17 @@ protected:
  * allocated by cairo or by the calling code. The supported image formats are
  * those defined in Format
  *
- * An ImageSurface is the most generic type of Surface and the only one that is
- * available by default.  You can either create an ImageSurface whose data is
- * managed by Cairo, or you can create an ImageSurface with a data buffer that
+ * An %ImageSurface is the most generic type of Surface and the only one that is
+ * available by default.  You can either create an %ImageSurface whose data is
+ * managed by Cairo, or you can create an %ImageSurface with a data buffer that
  * you allocated yourself so that you can have full access to the data.
  *
- * When you create an ImageSurface with your own data buffer, you are free to
+ * When you create an %ImageSurface with your own data buffer, you are free to
  * examine the results at any point and do whatever you want with it.  Note that
  * if you modify anything and later want to continue to draw to the surface
  * with cairo, you must let cairo know via Cairo::Surface::mark_dirty()
  *
- * Note that like all surfaces, an ImageSurface is a reference-counted object that should be used via Cairo::RefPtr.
+ * Note that like all surfaces, an %ImageSurface is a reference-counted object that should be used via Cairo::RefPtr.
  */
 class CAIROMM_API ImageSurface : public Surface
 {
@@ -773,7 +773,9 @@ public:
    * @param format the format of pixels in the buffer
    * @param width the width of the image to be stored in the buffer
    * @param height the height of the image to be stored in the buffer
-   * @param stride the number of bytes between the start of rows in the buffer as allocated. This value should always be computed by cairo_format_stride_for_width() before allocating the data buffer.
+   * @param stride the number of bytes between the start of rows in the buffer as allocated.
+   *        This value should always be computed by format_stride_for_width()
+   *        before allocating the data buffer.
    * @return a RefPtr to the newly created surface.
    */
   static RefPtr<ImageSurface> create(unsigned char* data, Format format, int width, int height, int stride);
@@ -834,7 +836,7 @@ public:
  * necessary objects (paths, patterns, etc.), in order to achieve accurate
  * replay.
  *
- * Note that like all surfaces, a RecordingSurface is a reference-counted object
+ * Note that like all surfaces, a %RecordingSurface is a reference-counted object
  * that should be used via Cairo::RefPtr.
  */
 class CAIROMM_API RecordingSurface : public Surface
@@ -922,7 +924,7 @@ typedef enum
   PDF_VERSION_1_5 = CAIRO_PDF_VERSION_1_5
 } PdfVersion;
 
-/** A PdfSurface provides a way to render PDF documents from cairo.  This
+/** A %PdfSurface provides a way to render PDF documents from cairo.  This
  * surface is not rendered to the screen but instead renders the drawing to a
  * PDF file on disk.
  *
@@ -1023,7 +1025,7 @@ typedef enum {
     PS_LEVEL_3 = CAIRO_PS_LEVEL_3
 } PsLevel;
 
-/** A PsSurface provides a way to render PostScript documents from cairo.  This
+/** A %PsSurface provides a way to render PostScript documents from cairo.  This
  * surface is not rendered to the screen but instead renders the drawing to a
  * PostScript file on disk.
  *
@@ -1176,7 +1178,7 @@ typedef enum
   SVG_VERSION_1_2 = CAIRO_SVG_VERSION_1_2
 } SvgVersion;
 
-/** A SvgSurface provides a way to render Scalable Vector Graphics (SVG) images
+/** A %SvgSurface provides a way to render Scalable Vector Graphics (SVG) images
  * from cairo.  This surface is not rendered to the screen but instead renders
  * the drawing to an SVG file on disk.
  *
@@ -1256,7 +1258,7 @@ public:
 
 #ifdef CAIRO_HAS_GLITZ_SURFACE
 
-/** A GlitzSurface provides a way to render to the X Window System using Glitz.
+/** A %GlitzSurface provides a way to render to the X Window System using Glitz.
  * This provides a way to use OpenGL-accelerated graphics from cairo.  If you
  * want to use hardware-accelerated graphics within the X Window system, you
  * should use this Surface type.