Changeset 862

Timestamp:

11/29/08 12:21:51 (15 years ago)

Author:

shofstad

Message:

added code comments (#406)

Location:

trunk/sources/HeuristicLab.Visualization

Files:

• ICanvas.cs (modified) (1 diff)
• Transform.cs (modified) (2 diffs)
• WorldShape.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Visualization/ICanvas.cs

@@ -2 +2 @@
 
 namespace HeuristicLab.Visualization {
+  /// <summary>
+  /// ICanvas Interface
+  /// </summary>
   public interface ICanvas {
     void Draw(Graphics graphics, Rectangle viewport);

trunk/sources/HeuristicLab.Visualization/Transform.cs

@@ -3 +3 @@
 namespace HeuristicLab.Visualization {
   public static class Transform {
-    // Screen to world transformations
+
+    /// <summary>
+    /// Screen to world transformations
+    /// </summary>
+    /// <param name="rect"></param>
+    /// <param name="viewport"></param>
+    /// <param name="clippingArea"></param>
+    /// <returns></returns>
     public static RectangleD ToWorld(Rectangle rect, Rectangle viewport, RectangleD clippingArea) {
       double x1 = ToWorldX(rect.Left, viewport, clippingArea);
@@ -26 +33 @@
     }
 
-    // World to screen transformations
+    /// <summary>
+    /// World to screen transformations
+    /// </summary>
+    /// <param name="rect"></param>
+    /// <param name="viewport"></param>
+    /// <param name="clippingArea"></param>
+    /// <returns></returns>
     public static Rectangle ToScreen(RectangleD rect, Rectangle viewport, RectangleD clippingArea) {
       int left = ToScreenX(rect.X1, viewport, clippingArea);

trunk/sources/HeuristicLab.Visualization/WorldShape.cs

@@ -29 +29 @@
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public RectangleD BoundingBox {
       get { return boundingBox; }
     }
 
+    /// <summary>
+    /// adds a shape to the WorldShape
+    /// </summary>
+    /// <param name="shape">shape to add</param>
     public void AddShape(IShape shape) {
       shapes.Add(shape);