Changeset 16942

Timestamp:

05/11/19 08:00:54 (6 years ago)

Author:

gkronber

Message:

#2875: Improve comments in NamedItem

File:

• trunk/HeuristicLab.Core/3.3/NamedItem.cs (modified) (7 diffs)

trunk/HeuristicLab.Core/3.3/NamedItem.cs

@@ -30 +30 @@
     [Storable]
     protected string name;
-    /// <inheritdoc/>
+    /// Gets and sets the name of the item.
     /// <remarks>Calls <see cref="OnNameChanging"/> and also <see cref="OnNameChanged"/> 
     /// eventually in the setter.</remarks>
@@ -74 +74 @@
     }
     /// <summary>
-    /// Initializes a new instance of <see cref="Variable"/> with name <c>Anonymous</c> 
+    /// Initializes a new instance of <see cref="NamedItem"/> with name and description <c>string.Empty</c> 
     /// and value <c>null</c>.
     /// </summary>
@@ -82 +82 @@
     }
     /// <summary>
-    /// Initializes a new instance of <see cref="Variable"/> with the specified <paramref name="name"/>
-    /// and the specified <paramref name="value"/>.
+    /// Initializes a new instance of <see cref="NamedItem"/> with the specified <paramref name="name"/>
     /// </summary>
     /// <param name="name">The name of the current instance.</param>
-    /// <param name="value">The value of the current instance.</param>
     protected NamedItem(string name) {
       if (name == null) this.name = string.Empty;
@@ -92 +90 @@
       description = string.Empty;
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="NamedItem"/> with the specified <paramref name="name"/> and <paramref name="description"/>.
+    /// </summary>
     protected NamedItem(string name, string description) {
       if (name == null) this.name = string.Empty;
@@ -100 +101 @@
 
     /// <summary>
-    /// Gets the string representation of the current instance in the format: <c>Name: [null|Value]</c>.
+    /// Gets the string representation of the current instance.
     /// </summary>
     /// <returns>The current instance as a string.</returns>
@@ -122 +123 @@
     /// Fires a new <c>NameChanged</c> event.
     /// </summary>
-    /// <remarks>Calls <see cref="ItemBase.OnChanged"/>.</remarks>
+    /// <remarks>Calls <see cref="Item.OnToStringChanged"/>.</remarks>
     protected virtual void OnNameChanged() {
       var handler = NameChanged;
@@ -133 +134 @@
     /// Fires a new <c>DescriptionChanged</c> event.
     /// </summary>
-    /// <remarks>Calls <see cref="ItemBase.OnChanged"/>.</remarks>
     protected virtual void OnDescriptionChanged() {
       var handler = DescriptionChanged;