Changeset 801 for trunk/sources/HeuristicLab.Operators/ScopeCleaner.cs

Timestamp:

11/21/08 09:48:11 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Operators namespace (#331)

File:

• trunk/sources/HeuristicLab.Operators/ScopeCleaner.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Operators/ScopeCleaner.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Operators {
+  /// <summary>
+  /// Operator that removes all variables in the given scope and deletes also all subscopes.
+  /// </summary>
   public class ScopeCleaner : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"Removes all variables in the current scope and deletes all subscopes"; }
     }
 
+    /// <summary>
+    /// Deletes all variable and sub scopes from the given <paramref name="scope"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="IScope.Clear"/> of interface <see cref="IScope"/>.</remarks>
+    /// <param name="scope">The scope to clear.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       scope.Clear();