Changeset 1346 for trunk/sources/HeuristicLab.Visualization/Legend

Timestamp:

03/13/09 20:12:20 (16 years ago)

Author:

shofstad

Message:

added code comments (#406)

File:

• trunk/sources/HeuristicLab.Visualization/Legend/LegendShape.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.Visualization/Legend/LegendShape.cs

@@ -72 +72 @@
     /// draws the legend as a row at the top or bottom of the WorldShape
     /// </summary>
-    /// <param name="item"></param>
-    /// <param name="x"></param>
-    /// <param name="y"></param>
+    /// <param name="item">the legenditem to draw</param>
+    /// <param name="x">x axis to draw the item</param>
+    /// <param name="y">y axis to draw the item</param>
     private void CreateRow(LegendItem item, double x, double y) {
       AddShape(new LineShape(x, y - 10, x + 20, y - 10, item.Color, item.Thickness, DrawingStyle.Solid));
@@ -83 +83 @@
     /// draws the legend as a column on the right or left side of the WorldShape
     /// </summary>
-    /// <param name="item"></param>
-    /// <param name="y"></param>
+    /// <param name="item">the legenditem to draw</param>
+    /// <param name="y">y axis to draw the item</param>
     private void CreateColumn(LegendItem item, double y) {
       AddShape(new LineShape(10, y - 10, 30, y - 10, item.Color, item.Thickness, DrawingStyle.Solid));
@@ -90 +90 @@
     }
 
+    /// <summary>
+    /// adds a legenditem to the items list
+    /// </summary>
+    /// <param name="item">legenditem to add</param>
     public void AddLegendItem(LegendItem item) {
       legendItems.Add(item);
     }
 
+    /// <summary>
+    /// removes a legenditem from the items list
+    /// </summary>
+    /// <param name="item">legenditem to remove</param>
     public void RemoveLegendItem(LegendItem item) {
       legendItems.Remove(item);
     }
 
+    /// <summary>
+    /// deletes the legenditem list
+    /// </summary>
     public void ClearLegendItems() {
       legendItems.Clear();
@@ -118 +129 @@
     }
 
+    /// <summary>
+    /// updates the font settings of the legend
+    /// </summary>
     private void UpdateTextShapes() {
       foreach (IShape shape in shapes) {