Changeset 1167 for trunk/sources/HeuristicLab.Logging/PointXYChart.cs

Timestamp:

01/22/09 12:06:29 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Operators.Metaprogramming and HeuristicLab.Logging namespace and changed a comment in HeuristicLab.Core namespace(#331)

File:

• trunk/sources/HeuristicLab.Logging/PointXYChart.cs (modified) (7 diffs)

trunk/sources/HeuristicLab.Logging/PointXYChart.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Logging {
+  /// <summary>
+  /// Class for point xy charts.
+  /// </summary>
   public class PointXYChart : ItemBase, IVisualizationItem {
     private ItemList myValues;
+    /// <summary>
+    /// Gets or sets the values of the current instance.
+    /// </summary>
+    /// <remarks>Calls <see cref="OnValuesChanged"/> in the setter.</remarks>
     public ItemList Values {
       get { return myValues; }
@@ -41 +48 @@
 
     private BoolData myConnectDots;
+    /// <summary>
+    /// Gets or sets the flag whether the dots should be connected or not.
+    /// </summary>
+    /// <remarks>Calls <see cref="OnConnectDotsChanged"/> in the setter.</remarks>
     public BoolData ConnectDots {
       get { return myConnectDots; }
@@ -52 +63 @@
  
          
-   
+    /// <summary>
+    /// Initializes a new instance of <see cref="PointXYChart"/> with the <c>ConnectDots</c> flag set to 
+    /// <c>true</c>.
+    /// </summary>
     public PointXYChart() {
       myConnectDots = new BoolData(true);
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="PointXYChart"/> with the given <paramref name="connectDots"/>
+    /// flag and the specified <paramref name="values"/>.
+    /// </summary>
+    /// <param name="connectDots">The flag whether the dots should be connected or not.</param>
+    /// <param name="values">The values with which the current instance should be initialized.</param>
     public PointXYChart(bool connectDots,ItemList values) {
       myConnectDots = new BoolData(connectDots);
@@ -61 +81 @@
     }
 
+    /// <summary>
+    /// Clones the current instance (deep clone).
+    /// </summary>
+    /// <remarks>Deep clone through <see cref="Auxiliary.Clone"/> method of helper class 
+    /// <see cref="Auxiliary"/>.</remarks>
+    /// <param name="clonedObjects">Dictionary of all already clone objects. (Needed to avoid cycles.)</param>
+    /// <returns>The cloned object as <see cref="PointXYChart"/>.</returns>
     public override object Clone(IDictionary<Guid, object> clonedObjects) {
       PointXYChart clone = (PointXYChart)base.Clone(clonedObjects);
@@ -67 +94 @@
     }
 
+    /// <summary>
+    /// Creates a new instance of <see cref="PointXYChartView"/> to represent the current instance visually.
+    /// </summary>
+    /// <returns>The created view as <see cref="PointXYChartView"/>.</returns>
     public override IView CreateView() {
       return new PointXYChartView(this);
     }
 
+    /// <summary>
+    /// Occurs when the values of the current instance have been changed.
+    /// </summary>
     public event EventHandler ValuesChanged;
+    /// <summary>
+    /// Fires a <c>ValuesChanged</c> event.
+    /// </summary>
     protected virtual void OnValuesChanged() {
       if (ValuesChanged != null)
         ValuesChanged(this, new EventArgs());
     }
+    /// <summary>
+    /// Occurs when the boolean flag has been changed.
+    /// </summary>
     public event EventHandler ConnectDotsChanged;
+    /// <summary>
+    /// Fires a <c>ConnectDotsChanged</c> event.
+    /// </summary>
     protected virtual void OnConnectDotsChanged() {
       if (ConnectDotsChanged != null)
@@ -83 +126 @@
 
     #region Persistence Methods
+    /// <summary>
+    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
+    /// </summary>
+    /// <remarks>The ConnectDots flag and the values of the current instance are saved as child nodes
+    /// with tag names <c>ConnectDots</c> and <c>Values</c> respectively.</remarks>
+    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
+    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
+    /// <param name="persistedObjects">The dictionary of all already persisted objects. 
+    /// (Needed to avoid cycles.)</param>
+    /// <returns>The saved <see cref="XmlNode"/>.</returns>
     public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects) {
       XmlNode node = base.GetXmlNode(name, document, persistedObjects);
@@ -89 +142 @@
       return node;
     }
+    /// <summary>
+    /// Loads the persisted item from the specified <paramref name="node"/>.
+    /// </summary>
+    /// <remarks>Has to be saved in a special way, see <see cref="GetXmlNode"/> for further information.</remarks>
+    /// <param name="node">The <see cref="XmlNode"/> where the PointXYChart is saved.</param>
+    /// <param name="restoredObjects">The dictionary of all already restored objects. 
+    /// (Needed to avoid cycles.)</param>
     public override void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects) {
       base.Populate(node, restoredObjects);