[cairo-commit] cairomm/cairomm cairomm.h, 1.5, 1.6 context.h, 1.15,
1.16 path.h, 1.7, 1.8 scaledfont.h, 1.1, 1.2 surface.h, 1.16,
1.17 win32_surface.h, 1.4, 1.5 xlib_surface.h, 1.6, 1.7
Murray Cumming
commit at pdx.freedesktop.org
Wed Jul 5 07:59:14 PDT 2006
Committed by: murrayc
Update of /cvs/cairo/cairomm/cairomm
In directory kemper:/tmp/cvs-serv4216/cairomm
Modified Files:
cairomm.h context.h path.h scaledfont.h surface.h
win32_surface.h xlib_surface.h
Log Message:
2006-07-05 Murray Cumming <murrayc at murrayc.com>
* cairomm/cairomm.h:
* cairomm/context.h:
* cairomm/path.h:
* cairomm/scaledfont.h:
* cairomm/surface.h:
* cairomm/win32_surface.h:
* cairomm/xlib_surface.h: Use @ instead of \ for doxygen
commands, to be consistent with gtkmm, which uses it because it is the
same as JavaDoc, with which some people are already familiar.
Index: cairomm.h
===================================================================
RCS file: /cvs/cairo/cairomm/cairomm/cairomm.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- cairomm.h 9 May 2006 03:12:42 -0000 1.5
+++ cairomm.h 5 Jul 2006 14:59:12 -0000 1.6
@@ -19,12 +19,12 @@
#ifndef __CAIROMM_H
#define __CAIROMM_H
-/** \mainpage Cairomm: A C++ wrapper for the cairo graphics library
+/** @mainpage Cairomm: A C++ wrapper for the cairo graphics library
*
- * \section License
+ * @section License
* Cairomm is available under the terms of the LGPL license
*
- * \section Introduction
+ * @section Introduction
* If you're just beginning to learn cairomm, a good place to start is with the
* Cairo::Surface and Cairo::Context classes. In general terms, you draw onto
* a Surface using the graphics settings specified in your Context.
Index: context.h
===================================================================
RCS file: /cvs/cairo/cairomm/cairomm/context.h,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- context.h 23 Jun 2006 18:37:44 -0000 1.15
+++ context.h 5 Jul 2006 14:59:12 -0000 1.16
@@ -249,7 +249,7 @@
* @param dashes an array specifying alternate lengths of on and off portions
* @param offset an offset into the dash pattern at which the stroke should start
*
- * \exception
+ * @exception
*/
void set_dash(std::valarray<double>& dashes, double offset);
@@ -583,11 +583,11 @@
* line width, line join, line cap, and dash settings. After stroke(),
* the current Path will be cleared from the cairo Context.
*
- * \sa set_line_width()
- * \sa set_line_join()
- * \sa set_line_cap()
- * \sa set_dash()
- * \sa stroke_preserve().
+ * @sa set_line_width()
+ * @sa set_line_join()
+ * @sa set_line_cap()
+ * @sa set_dash()
+ * @sa stroke_preserve().
*/
void stroke();
@@ -595,11 +595,11 @@
* line width, line join, line cap, and dash settings. Unlike stroke(),
* stroke_preserve() preserves the Path within the cairo Context.
*
- * \sa set_line_width()
- * \sa set_line_join()
- * \sa set_line_cap()
- * \sa set_dash()
- * \sa stroke_preserve().
+ * @sa set_line_width()
+ * @sa set_line_join()
+ * @sa set_line_cap()
+ * @sa set_dash()
+ * @sa stroke_preserve().
*/
void stroke_preserve();
@@ -607,8 +607,8 @@
* fill rule, (each sub-path is implicitly closed before being filled). After
* fill(), the current path will be cleared from the cairo context.
*
- * \sa set_fill_rule()
- * \sa fill_preserve()
+ * @sa set_fill_rule()
+ * @sa fill_preserve()
*/
void fill();
@@ -617,8 +617,8 @@
* Unlike fill(), fill_preserve() preserves the path within the
* cairo Context.
*
- * \sa set_fill_rule()
- * \sa fill().
+ * @sa set_fill_rule()
+ * @sa fill().
*/
void fill_preserve();
void copy_page();
@@ -656,7 +656,7 @@
* save()/restore() pair. The only other means of increasing the size of the
* clip region is reset_clip().
*
- * \sa set_fill_rule()
+ * @sa set_fill_rule()
*/
void clip();
@@ -667,8 +667,8 @@
* Unlike clip(), cairo_clip_preserve preserves the path within the cairo
* Context.
*
- * \sa clip()
- * \sa set_fill_rule()
+ * @sa clip()
+ * @sa set_fill_rule()
*/
void clip_preserve();
void select_font_face(const std::string& family, FontSlant slant, FontWeight weight);
@@ -761,17 +761,17 @@
//TODO: Copy or reference-count a Path somethow instead of asking the caller to delete it?
/** Creates a copy of the current path and returns it to the user.
*
- * \todo See cairo_path_data_t for hints on how to iterate over the returned
+ * @todo See cairo_path_data_t for hints on how to iterate over the returned
* data structure.
*
- * \note The caller owns the Path object returned from this function. The
+ * @note The caller owns the Path object returned from this function. The
* Path object must be freed when you are finished with it.
*/
Path* copy_path() const;
/** Gets a flattened copy of the current path and returns it to the user
*
- * \todo See cairo_path_data_t for hints on how to iterate over the returned
+ * @todo See cairo_path_data_t for hints on how to iterate over the returned
* data structure.
*
* This function is like copy_path() except that any curves in the path will
@@ -780,7 +780,7 @@
* any elements of type CAIRO_PATH_CURVE_TO which will instead be
* replaced by a series of CAIRO_PATH_LINE_TO elements.
*
- * \note The caller owns the Path object returned from this function. The
+ * @note The caller owns the Path object returned from this function. The
* Path object must be freed when you are finished with it.
*/
Path* copy_path_flat() const;
@@ -843,7 +843,7 @@
* content type is the only distinction between this function and push_group()
* which you should see for a more detailed description of group rendering.
*
- * \param content: indicates the type of group that will be created
+ * @param content: indicates the type of group that will be created
*/
void push_group_with_content(Content content);
@@ -856,7 +856,7 @@
* the push_group function), so that any changes to the graphics state will
* not be visible outside the group.
*
- * \return a (surface) pattern containing the results of all drawing
+ * @return a (surface) pattern containing the results of all drawing
* operations performed to the group.
**/
RefPtr<Pattern> pop_group();
Index: path.h
===================================================================
RCS file: /cvs/cairo/cairomm/cairomm/path.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- path.h 9 May 2006 03:38:35 -0000 1.7
+++ path.h 5 Jul 2006 14:59:12 -0000 1.8
@@ -32,7 +32,7 @@
* Path. The application is responsible for freeing the Path object when it is
* no longer needed.
*
- * \todo There's currently no way to access the path data without reverting to
+ * @todo There's currently no way to access the path data without reverting to
* the C object (see cobj())
*/
class Path
Index: scaledfont.h
===================================================================
RCS file: /cvs/cairo/cairomm/cairomm/scaledfont.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- scaledfont.h 4 Jul 2006 23:06:07 -0000 1.1
+++ scaledfont.h 5 Jul 2006 14:59:12 -0000 1.2
@@ -64,13 +64,13 @@
/** Creates a ScaledFont object from a font face and matrices that describe
* the size of the font and the environment in which it will be used.
*
- * \param font_matrix font space to user space transformation matrix for the
+ * @param font_matrix font space to user space transformation matrix for the
* font. In the simplest case of a N point font, this matrix is just a scale
* by N, but it can also be used to shear the font or stretch it unequally
* along the two axes. See Context::set_font_matrix().
- * \param ctm user to device transformation matrix with which the font will be
+ * @param ctm user to device transformation matrix with which the font will be
* used.
- * \param options: options to use when getting metrics for the font and
+ * @param options: options to use when getting metrics for the font and
* rendering with it.
*/
static RefPtr<ScaledFont> create(FontFace font_face, Matrix& font_matrix,
@@ -94,10 +94,10 @@
* size of the rectangle, though they will affect the x_advance and y_advance
* values.
*
- * \param utf8 a string of text, encoded in UTF-8
- * \param extents Returns the extents of the given string
+ * @param utf8 a string of text, encoded in UTF-8
+ * @param extents Returns the extents of the given string
*
- * \since 1.2
+ * @since 1.2
*/
void text_extents(const std::string& utf8, TextExtents& extents) const;
@@ -111,33 +111,33 @@
* Note that whitespace glyphs do not contribute to the size of the rectangle
* (extents.width and extents.height).
*
- * \param glyphs A vector of glyphs to calculate the extents of
- * \param extents Returns the extents for the array of glyphs
+ * @param glyphs A vector of glyphs to calculate the extents of
+ * @param extents Returns the extents for the array of glyphs
**/
void glyph_extents(std::vector<Glyph> glyphs, TextExtents& extents);
/** The FontFace with which this ScaledFont was created.
- * \since 1.2
+ * @since 1.2
*/
RefPtr<FontFace> get_font_face() const;
/** Gets the FontOptions with which the ScaledFont was created.
- * \since 1.2
+ * @since 1.2
*/
void get_font_options(FontOptions& options) const;
/** Gets the font matrix with which the ScaledFont was created.
- * \since 1.2
+ * @since 1.2
*/
void get_font_matrix(Matrix& font_matrix) const;
/** Gets the CTM with which the ScaledFont was created.
- * \since 1.2
+ * @since 1.2
*/
void get_ctm(Matrix& ctm) const;
/** Gets the type of scaled Font
- * \since 1.2
+ * @since 1.2
*/
FontType get_type() const;
Index: surface.h
===================================================================
RCS file: /cvs/cairo/cairomm/cairomm/surface.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -d -r1.16 -r1.17
--- surface.h 4 Jul 2006 18:50:02 -0000 1.16
+++ surface.h 5 Jul 2006 14:59:12 -0000 1.17
@@ -156,7 +156,7 @@
/** Writes the contents of surface to a new file filename as a PNG image.
*
- * \note For this function to be available, cairo must have been compiled
+ * @note For this function to be available, cairo must have been compiled
* with PNG support
*
* @param filename the name of a file to write to
@@ -165,7 +165,7 @@
/** Writes the Surface to the write function.
*
- * \note For this function to be available, cairo must have been compiled
+ * @note For this function to be available, cairo must have been compiled
* with PNG support
*
* @param write_func The function to be called when the backend needs to
@@ -328,7 +328,7 @@
/** Creates a new image surface and initializes the contents to the given PNG
* file.
*
- * \note For this function to be available, cairo must have been compiled
+ * @note For this function to be available, cairo must have been compiled
* with PNG support.
*
* @param filename name of PNG file to load
@@ -340,7 +340,7 @@
/** Creates a new image surface from PNG data read incrementally via the
* read_func function.
*
- * \note For this function to be available, cairo must have been compiled
+ * @note For this function to be available, cairo must have been compiled
* with PNG support.
*
* @param read_func function called to read the data of the file
@@ -361,7 +361,7 @@
* surface is not rendered to the screen but instead renders the drawing to a
* PDF file on disk.
*
- * \note For this Surface to be available, cairo must have been compiled with
+ * @note For this Surface to be available, cairo must have been compiled with
* PDF support
*/
class PdfSurface : public Surface
@@ -406,8 +406,8 @@
* function immediately after creating the surface or immediately after
* completing a page with either Context::show_page() or Context::copy_page().
*
- * \param width_in_points new surface width, in points (1 point == 1/72.0 inch)
- * \param height_in_points new surface height, in points (1 point == 1/72.0 inch)
+ * @param width_in_points new surface width, in points (1 point == 1/72.0 inch)
+ * @param height_in_points new surface height, in points (1 point == 1/72.0 inch)
**/
void set_size(double width_in_points, double height_in_points);
@@ -422,7 +422,7 @@
* surface is not rendered to the screen but instead renders the drawing to a
* PostScript file on disk.
*
- * \note For this Surface to be available, cairo must have been compiled with
+ * @note For this Surface to be available, cairo must have been compiled with
* PostScript support
*/
class PsSurface : public Surface
@@ -468,15 +468,15 @@
* function immediately after creating the surface or immediately after
* completing a page with either Context::show_page() or Context::copy_page().
*
- * \param width_in_points new surface width, in points (1 point == 1/72.0 inch)
- * \param height_in_points new surface height, in points (1 point == 1/72.0 inch)
+ * @param width_in_points new surface width, in points (1 point == 1/72.0 inch)
+ * @param height_in_points new surface height, in points (1 point == 1/72.0 inch)
*/
void set_size(double width_in_points, double height_in_points);
/** Emit a comment into the PostScript output for the given surface. See the
* cairo reference documentation for more information.
*
- * \param comment a comment string to be emitted into the PostScript output
+ * @param comment a comment string to be emitted into the PostScript output
*/
void dsc_comment(std::string comment);
@@ -516,7 +516,7 @@
* from cairo. This surface is not rendered to the screen but instead renders
* the drawing to an SVG file on disk.
*
- * \note For this Surface to be available, cairo must have been compiled with
+ * @note For this Surface to be available, cairo must have been compiled with
* SVG support
*/
class SvgSurface : public Surface
@@ -562,14 +562,14 @@
* performed on the given surface. The simplest way to do this is to call this
* function immediately after creating the surface.
*
- * \since 1.2
+ * @since 1.2
*/
void restrict_to_version(SvgVersion version);
/** Retrieves the list of SVG versions supported by cairo. See
* restrict_to_version().
*
- * \since 1.2
+ * @since 1.2
*/
static const std::vector<SvgVersion> get_versions();
@@ -596,10 +596,10 @@
* want to use hardware-accelerated graphics within the X Window system, you
* should use this Surface type.
*
- * \note For this Surface to be available, cairo must have been compiled with
+ * @note For this Surface to be available, cairo must have been compiled with
* Glitz support
*
- * \warning This is an experimental surface. It is not yet marked as a fully
+ * @warning This is an experimental surface. It is not yet marked as a fully
* supported surface by the cairo library
*/
class GlitzSurface : public Surface
Index: win32_surface.h
===================================================================
RCS file: /cvs/cairo/cairomm/cairomm/win32_surface.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- win32_surface.h 15 Mar 2006 01:00:59 -0000 1.4
+++ win32_surface.h 5 Jul 2006 14:59:12 -0000 1.5
@@ -38,7 +38,7 @@
* want to draw to the screen within a Microsoft Windows application, you
* should use this Surface type.
*
- * \note For this Surface to be available, cairo must have been compiled with
+ * @note For this Surface to be available, cairo must have been compiled with
* Win32 support
*/
class Win32Surface : public Surface
Index: xlib_surface.h
===================================================================
RCS file: /cvs/cairo/cairomm/cairomm/xlib_surface.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- xlib_surface.h 4 Jul 2006 18:46:46 -0000 1.6
+++ xlib_surface.h 5 Jul 2006 14:59:12 -0000 1.7
@@ -39,7 +39,7 @@
* If you want to draw to the screen within an application that uses the X
* Window system, you should use this Surface type.
*
- * \note For this surface to be availabe, cairo must have been compiled with
+ * @note For this surface to be availabe, cairo must have been compiled with
* support for XLib Surfaces
*/
class XlibSurface : public Surface
@@ -60,7 +60,7 @@
* colors are represented in the drawable is specified by the provided
* visual.
*
- * \note If drawable is a Window, then the function
+ * @note If drawable is a Window, then the function
* cairo_xlib_surface_set_size must be called whenever the size of the window
* changes.
*
More information about the cairo-commit
mailing list