[librsvgmm] Document all classes and structs



commit 50eec0e0985a9114a35907536065e893fedcdd8c
Author: Daniel Elstner <daniel kitta gmail com>
Date:   Mon Sep 7 17:58:05 2009 +0200

    Document all classes and structs
    
    * librsvg/src/rsvg.hg: Add missing documentation blocks with at least
    a brief description to all classes and structs.

 librsvg/src/rsvg.hg |   30 ++++++++++++++++++++++++++++--
 1 files changed, 28 insertions(+), 2 deletions(-)
---
diff --git a/librsvg/src/rsvg.hg b/librsvg/src/rsvg.hg
index f6036c3..512089b 100644
--- a/librsvg/src/rsvg.hg
+++ b/librsvg/src/rsvg.hg
@@ -23,6 +23,8 @@ _PINCLUDE(glibmm/private/object_p.h)
 #include <cairomm/cairomm.h>
 #include <librsvg/rsvg.h>
 
+/** The librsvgmm namespace.
+ */
 namespace Rsvg
 {
 
@@ -34,16 +36,18 @@ void init();
  */
 void term();
 
+/** Exception class for reporting errors.
+ */
 _WRAP_GERROR(Error, RsvgError, RSVG_ERROR)
 
-/** Sets the DPI for the all future pixel calculations.
+/** Sets the DPI for all future pixel calculations.
  * Common values are 75, 90, and 300 DPI. Passing a number <= 0 to @a dpi
  * will reset the DPI to whatever the default value happens to be.
  * @param dpi Dots per inch (aka pixels per inch)
  */
 void set_default_dpi(double dpi);
 
-/** Sets the DPI for the all future pixel calculations.
+/** Sets the DPI for all future pixel calculations.
  * Common values are 75, 90, and 300 DPI. Passing a number <= 0 to @a dpi_x
  * or @a dpi_y will reset the DPI to whatever the default value happens to be.
  * @param dpi_x Horizontal dots per inch (aka pixels per inch)
@@ -51,16 +55,38 @@ void set_default_dpi(double dpi);
  */
 void set_default_dpi(double dpi_x, double dpi_y);
 
+/** Dimensions of an SVG fragment.
+ */
 struct DimensionData : RsvgDimensionData
 {
+  /** Initialize dimensions to 0.
+   */
   DimensionData() { width = 0; height = 0; em = 0.0; ex = 0.0; }
+
+#ifdef DOXYGEN_SHOULD_SKIP_THIS
+  int width;  /*!< Width in pixels. */
+  int height; /*!< Height in pixels. */
+  double em;
+  double ex;
+#endif
 };
 
+/** Position of an SVG fragment.
+ */
 struct PositionData : RsvgPositionData
 {
+  /** Initialize coordinates to 0.
+   */
   PositionData() { x = 0; y = 0; }
+
+#ifdef DOXYGEN_SHOULD_SKIP_THIS
+  int x; /*!< Horizontal position in pixels. */
+  int y; /*!< Vertical position in pixels. */
+#endif
 };
 
+/** Create and manipulate SVG objects.
+ */
 class Handle : public Glib::Object
 {
   _CLASS_GOBJECT(Handle, RsvgHandle, RSVG_HANDLE, Glib::Object, GObject)



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]