[librsvgmm] Document hand-coded API functions



commit 206c19b8c1211baf77f882b2f0c8db22a796ba57
Author: Daniel Elstner <daniel kitta gmail com>
Date:   Thu Jun 18 02:03:42 2009 +0200

    Document hand-coded API functions
    
    * librsvg/src/rsvg.hg: Remove redundant "#include <glibmm.h>".
    (Rsvg::set_default_dpi): Document both overloads.
    (Rsvg::{Dimension,Position}Data): Remove redundant "public".

 librsvg/src/rsvg.hg |   17 ++++++++++++++---
 1 files changed, 14 insertions(+), 3 deletions(-)
---
diff --git a/librsvg/src/rsvg.hg b/librsvg/src/rsvg.hg
index 97907c8..ef23770 100644
--- a/librsvg/src/rsvg.hg
+++ b/librsvg/src/rsvg.hg
@@ -19,7 +19,6 @@
 _DEFS(librsvgmm,librsvg)
 _PINCLUDE(glibmm/private/object_p.h)
 
-#include <glibmm.h>
 #include <cairomm/cairomm.h>
 #include <librsvg/rsvg.h>
 
@@ -28,15 +27,27 @@ namespace Rsvg
 
 _WRAP_GERROR(Error, RsvgError, RSVG_ERROR)
 
+/** Sets the DPI for the 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.
+ * 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)
+ * @param dpi_y Vertical dots per inch (aka pixels per inch)
+ */
 void set_default_dpi(double dpi_x, double dpi_y);
 
-struct DimensionData : public RsvgDimensionData
+struct DimensionData : RsvgDimensionData
 {
   DimensionData() { width = 0; height = 0; em = 0.0; ex = 0.0; }
 };
 
-struct PositionData : public RsvgPositionData
+struct PositionData : RsvgPositionData
 {
   PositionData() { x = 0; y = 0; }
 };



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