Changeset 16942


Ignore:
Timestamp:
05/11/19 08:00:54 (2 weeks ago)
Author:
gkronber
Message:

#2875: Improve comments in NamedItem

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/HeuristicLab.Core/3.3/NamedItem.cs

    r16565 r16942  
    3030    [Storable]
    3131    protected string name;
    32     /// <inheritdoc/>
     32    /// Gets and sets the name of the item.
    3333    /// <remarks>Calls <see cref="OnNameChanging"/> and also <see cref="OnNameChanged"/>
    3434    /// eventually in the setter.</remarks>
     
    7474    }
    7575    /// <summary>
    76     /// Initializes a new instance of <see cref="Variable"/> with name <c>Anonymous</c>
     76    /// Initializes a new instance of <see cref="NamedItem"/> with name and description <c>string.Empty</c>
    7777    /// and value <c>null</c>.
    7878    /// </summary>
     
    8282    }
    8383    /// <summary>
    84     /// Initializes a new instance of <see cref="Variable"/> with the specified <paramref name="name"/>
    85     /// and the specified <paramref name="value"/>.
     84    /// Initializes a new instance of <see cref="NamedItem"/> with the specified <paramref name="name"/>
    8685    /// </summary>
    8786    /// <param name="name">The name of the current instance.</param>
    88     /// <param name="value">The value of the current instance.</param>
    8987    protected NamedItem(string name) {
    9088      if (name == null) this.name = string.Empty;
     
    9290      description = string.Empty;
    9391    }
     92    /// <summary>
     93    /// Initializes a new instance of <see cref="NamedItem"/> with the specified <paramref name="name"/> and <paramref name="description"/>.
     94    /// </summary>
    9495    protected NamedItem(string name, string description) {
    9596      if (name == null) this.name = string.Empty;
     
    100101
    101102    /// <summary>
    102     /// Gets the string representation of the current instance in the format: <c>Name: [null|Value]</c>.
     103    /// Gets the string representation of the current instance.
    103104    /// </summary>
    104105    /// <returns>The current instance as a string.</returns>
     
    122123    /// Fires a new <c>NameChanged</c> event.
    123124    /// </summary>
    124     /// <remarks>Calls <see cref="ItemBase.OnChanged"/>.</remarks>
     125    /// <remarks>Calls <see cref="Item.OnToStringChanged"/>.</remarks>
    125126    protected virtual void OnNameChanged() {
    126127      var handler = NameChanged;
     
    133134    /// Fires a new <c>DescriptionChanged</c> event.
    134135    /// </summary>
    135     /// <remarks>Calls <see cref="ItemBase.OnChanged"/>.</remarks>
    136136    protected virtual void OnDescriptionChanged() {
    137137      var handler = DescriptionChanged;
Note: See TracChangeset for help on using the changeset viewer.