wrote gtkruler - changed gtk_ruler_draw_tick and gtk_ruler_draw_pos to private

David Mason
dcm@redhat.com

1 files changed, 25 insertions, 17 deletions

diff --git a/docs/reference/gtk/tmpl/gtkruler.sgml b/docs/reference/gtk/tmpl/gtkruler.sgml
index 2dcf0028ac..3f32ee75ee 100644
--- a/docs/reference/gtk/tmpl/gtkruler.sgml
+++ b/docs/reference/gtk/tmpl/gtkruler.sgml
@@ -2,24 +2,30 @@
 GtkRuler
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Base class for horizontal or vertical rulers
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+The GTKRuler widget is a base class for horizontal and vertical rulers. Rulers
+are used to show the mouse pointer's location in a window. The ruler can either
+be horizontal or vertical on the window. Within the ruler a small triangle
+indicates the location of the mouse relative to the horixontal or vertical
+ruler. See #GtkHRuler to learn how to create a new horizontal ruler. See
+#GtkVRuler to learn how to create a new vertical ruler.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GtkHRuler, #GtkVRuler
 </para>
 
 <!-- ##### STRUCT GtkRuler ##### -->
 <para>
-
+All distances are in 1/72nd's of an inch. (According to Adobe thats a point, but
+points are really 1/72.27 in.)
 </para>
 
-@widget: 
+@widget:
 @backing_store: 
 @non_gr_exp_gc: 
 @metric: 
@@ -33,7 +39,7 @@ GtkRuler
 
 <!-- ##### STRUCT GtkRulerMetric ##### -->
 <para>
-
+This should be points_per_unit. This is the size of the unit in 1/72nd's of an inch and has nothing to do with screen pixels. 
 </para>
 
 @metric_name: 
@@ -44,23 +50,25 @@ GtkRuler
 
 <!-- ##### FUNCTION gtk_ruler_set_metric ##### -->
 <para>
-
+This calls the #GTKMetricType to set the ruler to units defined. Available units
+are GTK_PIXELS, GTK_INCHES, or GTK_CENTIMETERS. The default unit of measurement
+is GTK_PIXELS.
 </para>
 
-@ruler: 
-@metric: 
+@ruler: the gtkruler
+@metric: the unit of measurement
 
 
 <!-- ##### FUNCTION gtk_ruler_set_range ##### -->
 <para>
-
+This sets the range of the ruler using gfloat lower, gfloat upper, gfloat position, and gfloat max_size. 
 </para>
 
-@ruler: 
-@lower: 
-@upper: 
-@position: 
-@max_size: 
+@ruler: the gtkruler
+@lower:the upper limit of the ruler
+@upper:the lower limit of the ruler
+@position:the mark on the ruler 
+@max_size:the maximum size of the ruler 
 
 
 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
@@ -68,7 +76,7 @@ GtkRuler
 
 </para>
 
-@ruler: 
+@ruler: the gtkruler
 
 
 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
@@ -76,6 +84,6 @@ GtkRuler
 
 </para>
 
-@ruler: 
+@ruler: the gtkruler