Changeset 1189 for trunk/sources/HeuristicLab.PluginInfrastructure/BaseClasses/ApplicationBase.cs

Timestamp:

01/30/09 12:46:32 (15 years ago)

Author:

vdorfer

Message:

Created parts of the API documentation for HeuristicLab.PluginInfrastructure namespace (#331)

File:

• trunk/sources/HeuristicLab.PluginInfrastructure/BaseClasses/ApplicationBase.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.PluginInfrastructure/BaseClasses/ApplicationBase.cs

@@ -26 +26 @@
 
 namespace HeuristicLab.PluginInfrastructure {
+  /// <summary>
+  /// Default implementation for the IApplication interface.
+  /// </summary>
   public abstract class ApplicationBase : IApplication {
     private string name;
@@ -32 +35 @@
     private bool autoRestart;
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ApplicationBase"/>.
+    /// </summary>
     public ApplicationBase() {
       ReadAttributes();
@@ -75 +81 @@
     #region IApplication Members
 
+    /// <summary>
+    /// Gets the name of the application.
+    /// </summary>
     public string Name {
       get { return name; }
     }
 
+    /// <summary>
+    /// Gets the version of the application.
+    /// </summary>
     public Version Version {
       get { return version; }
     }
 
+    /// <summary>
+    /// Gets the description of the application.
+    /// </summary>
     public string Description {
       get { return description; }
     }
 
+    /// <summary>
+    /// Gets the boolean flag whether the application should automatically get restarted.
+    /// </summary>
     public bool AutoRestart {
       get { return autoRestart; }
     }
 
+    /// <summary>
+    /// Runs the application.
+    /// </summary>
     public abstract void Run();