Changeset 851 for trunk/sources

Timestamp:

11/28/08 11:41:03 (16 years ago)

Author:

vdorfer

Message:

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

Location:

trunk/sources/HeuristicLab.SequentialEngine

Files:

• HeuristicLabSequentialEnginePlugin.cs (modified) (1 diff)
• SequentialEngine.cs (modified) (2 diffs)
• SequentialEngineEditor.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.SequentialEngine/HeuristicLabSequentialEnginePlugin.cs

@@ -26 +26 @@
 
 namespace HeuristicLab.SequentialEngine {
+  /// <summary>
+  /// Plugin class for HeuristicLab.SequentialEngine plugin.
+  /// </summary>
   [ClassInfo(Name = "HeuristicLab.SequentialEngine-3.2")]
   [PluginFile(Filename = "HeuristicLab.SequentialEngine-3.2.dll", Filetype = PluginFileType.Assembly)]

trunk/sources/HeuristicLab.SequentialEngine/SequentialEngine.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.SequentialEngine {
+  /// <summary>
+  /// Represents an engine that executes its steps sequentially, also if they could be executed 
+  /// in parallel.
+  /// </summary>
   public class SequentialEngine : EngineBase, IEditable {
     private IOperator currentOperator;
 
+    /// <summary>
+    /// Creates a new instance of <see cref="SequentialEngineEditor"/>.
+    /// </summary>
+    /// <returns>The created view as <see cref="SequentialEngineEditor"/>.</returns>
     public override IView CreateView() {
       return new SequentialEngineEditor(this);
     }
+
+    /// <summary>
+    /// Creates a new instance of <see cref="SequentialEngineEditor"/>.
+    /// </summary>
+    /// <returns>The created editor as <see cref="SequentialEngineEditor"/>.</returns>
     public virtual IEditor CreateEditor() {
       return new SequentialEngineEditor(this);
     }
 
+    /// <summary>
+    /// Aborts the current operator.
+    /// </summary>
+    /// <remarks>Calls <see cref="EngineBase.Abort"/> of base class <see cref="EngineBase"/> and
+    /// <see cref="IOperator.Abort"/> of the current <see cref="IOperator"/>.</remarks>
     public override void Abort() {
       base.Abort();
@@ -43 +61 @@
     }
 
+    /// <summary>
+    /// Deals with the next operation, if it is an <see cref="AtomicOperation"/> it is executed,
+    /// if it is a <see cref="CompositeOperation"/> its single operations are pushed on the execution stack.
+    /// </summary>
+    /// <remarks>If an error occurs during the execution the operation is aborted and the operation
+    /// is pushed on the stack again.<br/>
+    /// If the execution was successful <see cref="EngineBase.OnOperationExecuted"/> is called.</remarks>
     protected override void ProcessNextOperation() {
       IOperation operation = myExecutionStack.Pop();

trunk/sources/HeuristicLab.SequentialEngine/SequentialEngineEditor.cs

@@ -30 +30 @@
 
 namespace HeuristicLab.SequentialEngine {
+  /// <summary>
+  /// Visual representation of a <see cref="SequentialEngine"/>.
+  /// </summary>
   public partial class SequentialEngineEditor : EngineBaseEditor {
+    /// <summary>
+    /// Gets or set the engine to represent visually.
+    /// </summary>
+    /// <remarks>Uses property <see cref="EngineBaseEditor.Engine"/> of base class 
+    /// <see cref="EngineBaseEditor"/>. No own data storage present.</remarks>
     public SequentialEngine SequentialEngine {
       get { return (SequentialEngine)Engine; }
@@ -36 +44 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="SequentialEngineEditor"/>.
+    /// </summary>
     public SequentialEngineEditor() {
       InitializeComponent();
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="SequentialEngineEditor"/> with the given
+    /// <paramref name="sequentialEngine"/>.
+    /// </summary>
+    /// <param name="sequentialEngine">The engine to display.</param>
     public SequentialEngineEditor(SequentialEngine sequentialEngine)
       : this() {