Add surface examples to doxygen documentation

2 files changed, 19 insertions, 0 deletions

diff --git a/ChangeLog b/ChangeLog
index 2245450..ff30bc5 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2008-12-12  Jonathon Jongsma  <jonathon@quotidian.org>
 
+	* cairomm/surface.h: add the surface examples to the doxygen documentation
+
+2008-12-12  Jonathon Jongsma  <jonathon@quotidian.org>
+
 	Restructure the examples directory so that there aren't so many subdirs, which
 	tends to slow down builds since they can't be done in parallel.  Also
 	'standardize' the executable names a bit more and give the source files
diff --git a/cairomm/surface.h b/cairomm/surface.h
index 8e1e25c..983415f 100644
--- a/cairomm/surface.h
+++ b/cairomm/surface.h
@@ -304,6 +304,9 @@ protected:
   cobject* m_cobject;
 };
 
+/** @example image-surface.cc
+ * An example of using Cairo::ImageSurface class to render to PNG
+ */
 
 /** Image surfaces provide the ability to render to memory buffers either
  * allocated by cairo or by the calling code. The supported image formats are
@@ -469,6 +472,10 @@ public:
 
 #ifdef CAIRO_HAS_PDF_SURFACE
 
+/** @example pdf-surface.cc
+ * An example of using Cairo::PdfSurface class to render to PDF
+ */
+
 /** 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.
@@ -533,6 +540,10 @@ public:
 
 #ifdef CAIRO_HAS_PS_SURFACE
 
+/** @example ps-surface.cc
+ * An example of using Cairo::PsSurface class to render to PostScript
+ */
+
 /**
  * describes the language level of the PostScript Language Reference that a
  * generated PostScript file will conform to.
@@ -687,6 +698,10 @@ public:
 
 #ifdef CAIRO_HAS_SVG_SURFACE
 
+/** @example svg-surface.cc
+ * An example of using Cairo::SvgSurface class to render to SVG
+ */
+
 typedef enum
 {
   SVG_VERSION_1_1 = CAIRO_SVG_VERSION_1_1,