add documentation

diff --git a/ChangeLog b/ChangeLog
index fae9f21ac770c0f7efd6dacbc98a6b8c62e0ac7f..03d4b32fb74228ee12b9a27562220f5e0b7142eb 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2006-03-31  MenTaLguY  <mental@rydia.net>
+
+    * src/dyna-draw-context.h: add documentation
+
 2006-03-29  Andrius R. <knutux@gmail.com>
 
        * src/enums.h, src/selection-chemistry.cpp,

diff --git a/src/dyna-draw-context.h b/src/dyna-draw-context.h
index ea6822f18e4f67ae09eb577ec1e8dc9bf5339785..06aeca1e34f9444f499821bf75dac9fdf65eea05 100644 (file)
--- a/src/dyna-draw-context.h
+++ b/src/dyna-draw-context.h
@@ -46,16 +46,27 @@ struct SPDynaDrawContext
 {
     SPEventContext event_context;
 
+    /** accumulated shape which ultimately goes in svg:path */
     SPCurve *accumulated;
+
+    /** canvas items for "comitted" segments */
     GSList *segments;
-    /* current shape and curves */
+
+    /** canvas item for red "leading" segment */
     SPCanvasItem *currentshape;
+    /** shape of red "leading" segment */
     SPCurve *currentcurve;
+
+    /** left edge of the stroke; combined to get accumulated */
     SPCurve *cal1;
+    /** right edge of the stroke; combined to get accumulated */
     SPCurve *cal2;
-    /* temporary work area */
+
+    /** left edge points for this segment */
     NR::Point point1[SAMPLING_SIZE];
+    /** right edge points for this segment */
     NR::Point point2[SAMPLING_SIZE];
+    /** number of edge points for this segment */
     gint npoints;
 
     /* repr */