Free cookie consent management tool by TermsFeed Policy Generator

Ignore:
Timestamp:
01/30/09 12:46:32 (15 years ago)
Author:
vdorfer
Message:

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

Location:
trunk/sources/HeuristicLab.PluginInfrastructure/BaseClasses
Files:
2 edited

Legend:

Unmodified
Added
Removed

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

    r242 r1189  
    2626
    2727namespace HeuristicLab.PluginInfrastructure {
     28  /// <summary>
     29  /// Default implementation for the IApplication interface.
     30  /// </summary>
    2831  public abstract class ApplicationBase : IApplication {
    2932    private string name;
    … …  
    3235    private bool autoRestart;
    3336
     37    /// <summary>
     38    /// Initializes a new instance of <see cref="ApplicationBase"/>.
     39    /// </summary>
    3440    public ApplicationBase() {
    3541      ReadAttributes();
    … …  
    7581    #region IApplication Members
    7682
     83    /// <summary>
     84    /// Gets the name of the application.
     85    /// </summary>
    7786    public string Name {
    7887      get { return name; }
    7988    }
    8089
     90    /// <summary>
     91    /// Gets the version of the application.
     92    /// </summary>
    8193    public Version Version {
    8294      get { return version; }
    8395    }
    8496
     97    /// <summary>
     98    /// Gets the description of the application.
     99    /// </summary>
    85100    public string Description {
    86101      get { return description; }
    87102    }
    88103
     104    /// <summary>
     105    /// Gets the boolean flag whether the application should automatically get restarted.
     106    /// </summary>
    89107    public bool AutoRestart {
    90108      get { return autoRestart; }
    91109    }
    92110
     111    /// <summary>
     112    /// Runs the application.
     113    /// </summary>
    93114    public abstract void Run();
    94115

  • trunk/sources/HeuristicLab.PluginInfrastructure/BaseClasses/PluginBase.cs

    r8 r1189  
    3636    private string description;
    3737
     38    /// <summary>
     39    /// Initializes a new instance of <see cref="PluginBase"/>.
     40    /// </summary>
    3841    public PluginBase() {
    3942      ReadAttributes();
    … …  
    8487
    8588    #region IPlugin Members
     89    /// <summary>
     90    /// Gets the name of the plugin.
     91    /// </summary>
    8692    public string Name {
    8793      get {
    … …  
    9096    }
    9197
     98    /// <summary>
     99    /// Gets the version of the plugin.
     100    /// </summary>
    92101    public Version Version {
    93102      get {
    … …  
    96105    }
    97106
     107    /// <summary>
     108    /// Gets the description of the plugin.
     109    /// </summary>
    98110    public string Description {
    99111      get {
    … …  
    102114    }
    103115
     116    /// <inheritdoc/>
    104117    public  string[] Files {
    105118      get {
    … …  
    108121    }
    109122
     123    /// <inheritdoc/>
    110124    public virtual void OnInstall() {
    111125    }
    112126
     127    /// <inheritdoc/>
    113128    public virtual void OnDelete() {
    114129    }
    115130
     131    /// <inheritdoc/>
    116132    public virtual void OnPreUpdate() {
    117133    }
    118134
     135    /// <inheritdoc/>
    119136    public virtual void OnPostUpdate() {
    120137    }
Note: See TracChangeset for help on using the changeset viewer.