Free cookie consent management tool by TermsFeed Policy Generator

Changeset 3092


Ignore:
Timestamp:
03/17/10 19:01:27 (14 years ago)
Author:
gkronber
Message:

Fixed relevant warnings in the plugin infrastructure (didn't fix warnings about XML comments of members that will be removed soon). #915 (Remove warnings from HL 3.3 solution)

Location:
trunk/sources
Files:
20 edited

Legend:

Unmodified
Added
Removed

  • trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/DeploymentService/AdminClientFactory.cs

    r3006 r3092  
    88
    99namespace HeuristicLab.PluginInfrastructure.Advanced.DeploymentService {
     10  /// <summary>
     11  /// Factory class to generated administration client instances for the deployment service.
     12  /// </summary>
    1013  public static class AdminClientFactory {
    1114    private static byte[] serverCrtData;
    1215
     16    /// <summary>
     17    /// static constructor loads the embedded service certificate
     18    /// </summary>
    1319    static AdminClientFactory() {
    1420      var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream("HeuristicLab.PluginInfrastructure.Advanced.DeploymentService.servdev.cer");
    … …  
    1723    }
    1824
     25    /// <summary>
     26    /// Factory method to create new administration clients for the deployment service.
     27    /// Sets the connection string and user credentials from values provided in settings.
     28    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationUserName
     29    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationPassword
     30    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationnAdministrationAddress
     31    ///
     32    /// </summary>
     33    /// <returns>A new instance of an adimistration client</returns>
    1934    public static AdminClient CreateClient() {
    2035      var client = new AdminClient();

  • trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/DeploymentService/DeploymentService.cs

    r2860 r3092  
    1 //------------------------------------------------------------------------------
     1#pragma warning disable 1591
     2//------------------------------------------------------------------------------
    23// <auto-generated>
    34//     This code was generated by a tool.
    … …  
    313314    }
    314315}
     316#pragma warning restore 1591

  • trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/DeploymentService/PluginDescription.cs

    r2922 r3092  
    3232  // extension of auto-generated DataContract class PluginDescription
    3333  public partial class PluginDescription : IPluginDescription {
     34    /// <summary>
     35    /// Initializes an new instance of <see cref="PluginDescription" />
     36    /// with no dependencies, empty contact details and empty license text.
     37    /// </summary>
     38    /// <param name="name">Name of the plugin</param>
     39    /// <param name="version">Version of the plugin</param>
    3440    public PluginDescription(string name, Version version) : this(name, version, new List<PluginDescription>()) { }
     41    /// <summary>
     42    /// Initializes a new instance of <see cref="PluginDescription" />
     43    /// with empty contact details and empty license text.
     44    /// </summary>
     45    /// <param name="name">Name of the plugin</param>
     46    /// <param name="version">Version of the plugin</param>
     47    /// <param name="dependencies">Enumerable of dependencies of the plugin</param>
    3548    public PluginDescription(string name, Version version, IEnumerable<PluginDescription> dependencies)
    3649      : this(name, version, dependencies, string.Empty, string.Empty, string.Empty) {
    3750    }
    3851
     52    /// <summary>
     53    /// Initializes a new instance of <see cref="PluginDescription" />.
     54    /// </summary>
     55    /// <param name="name">Name of the plugin</param>
     56    /// <param name="version">Version of the plugin</param>
     57    /// <param name="dependencies">Enumerable of dependencies of the plugin</param>
     58    /// <param name="contactName">Name of the contact person for the plugin</param>
     59    /// <param name="contactEmail">E-mail of the contact person for the plugin</param>
     60    /// <param name="licenseText">License text for the plugin</param>
    3961    public PluginDescription(string name, Version version, IEnumerable<PluginDescription> dependencies, string contactName, string contactEmail, string licenseText) {
    4062      this.Name = name;
    … …  
    4567
    4668    #region IPluginDescription Members
     69    /// <summary>
     70    /// Gets the description of the plugin. Always string.Empty.
     71    /// </summary>
    4772    public string Description {
    4873      get { return string.Empty; }
    … …  
    5479    }
    5580
     81    /// <summary>
     82    /// Gets an enumerable of dependencies of the plugin
     83    /// </summary>
    5684    IEnumerable<IPluginDescription> IPluginDescription.Dependencies {
    5785      get {
    … …  
    6088    }
    6189
     90    /// <summary>
     91    /// Gets and enumerable of files that are part of this pluing. Always empty.
     92    /// </summary>
    6293    public IEnumerable<IPluginFile> Files {
    6394      get { return Enumerable.Empty<IPluginFile>(); }
    … …  
    6697    #endregion
    6798
     99    /// <summary>
     100    /// ToString override
     101    /// </summary>
     102    /// <returns>String representation of the PluginDescription (name + version)</returns>
    68103    public override string ToString() {
    69104      return Name + " " + Version;

  • trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/DeploymentService/ProductDescription.cs

    r2860 r3092  
    3131namespace HeuristicLab.PluginInfrastructure.Advanced.DeploymentService {
    3232  // extension of auto-generated DataContract class ProductDescription
     33  /// <summary>
     34  /// Product description as provided by the deployment service.
     35  /// A product has a name, a version and a list of plugins that are part of the product.
     36  /// </summary>
    3337  public partial class ProductDescription  {
     38    /// <summary>
     39    /// Initializes a new instance of <see cref="ProductDescription" />
     40    /// </summary>
     41    /// <param name="name">Name of the product</param>
     42    /// <param name="version">Version of the product</param>
    3443    public ProductDescription(string name, Version version)
    3544      : this(name, version, new List<PluginDescription>()) {
    3645    }
    3746
     47    /// <summary>
     48    /// Initializes a new instance of <see cref="ProductDescription" />
     49    /// </summary>
     50    /// <param name="name">Name of the product</param>
     51    /// <param name="version">Version of the product</param>
     52    /// <param name="plugins">Enumerable of plugins of the product</param>
    3853    public ProductDescription(string name, Version version, IEnumerable<PluginDescription> plugins) {
    3954      this.Name = name;

  • trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/DeploymentService/UpdateClientFactory.cs

    r3006 r3092  
    88
    99namespace HeuristicLab.PluginInfrastructure.Advanced.DeploymentService {
     10  /// <summary>
     11  /// Factory class to generated update client instances for the deployment service.
     12  /// </summary>
    1013  public static class UpdateClientFactory {
    1114    private static byte[] serverCrtData;
    1215
     16    /// <summary>
     17    /// static constructor loads the embedded service certificate
     18    /// </summary>
    1319    static UpdateClientFactory() {
    1420      var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream("HeuristicLab.PluginInfrastructure.Advanced.DeploymentService.servdev.cer");
    … …  
    1723    }
    1824
     25    /// <summary>
     26    /// Factory method to create new update clients for the deployment service.
     27    /// Sets the connection string and user credentials from values provided in settings.
     28    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationUserName
     29    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationPassword
     30    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocation
     31    ///
     32    /// </summary>
     33    /// <returns>A new instance of an update client</returns>
    1934    public static UpdateClient CreateClient() {
    2035      var client = new UpdateClient();

  • trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/InstallationManager.cs

    r3006 r3092  
    128128    /// Retrieves a list of plugins available at the remote server
    129129    /// </summary>
    130     /// <param name="connectionString"></param>
    131130    /// <returns></returns>
    132131    public IEnumerable<IPluginDescription> GetRemotePluginList() {
    … …  
    146145    /// Retrieves the list of products available at the remote server
    147146    /// </summary>
    148     /// <param name="connectionString"></param>
    149147    /// <returns></returns>
    150148    public IEnumerable<DeploymentService.ProductDescription> GetRemoteProductList() {
    … …  
    164162    ///  Installs plugins from remote server
    165163    /// </summary>
    166     /// <param name="connectionString"></param>
    167     /// <param name="pluginNames"></param>
     164    /// <param name="plugins"></param>
    168165    public void Install(IEnumerable<IPluginDescription> plugins) {
    169166      var args = new PluginInfrastructureCancelEventArgs(plugins);
    … …  
    188185    /// Updates plugins from remote server
    189186    /// </summary>
    190     /// <param name="pluginNames"></param>
     187    /// <param name="plugins"></param>
    191188    public void Update(IEnumerable<IPluginDescription> plugins) {
    192189      PluginInfrastructureCancelEventArgs args = new PluginInfrastructureCancelEventArgs(plugins);
    … …  
    211208    /// Deletes all plugin files from local installation
    212209    /// </summary>
    213     /// <param name="pluginNames"></param>
     210    /// <param name="plugins"></param>
    214211    public void Remove(IEnumerable<IPluginDescription> plugins) {
    215212      var fileNames = from pluginToDelete in plugins

  • trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/LicenseView.cs

    r3006 r3092  
    1 using System;
     1#region License Information
     2/* HeuristicLab
     3 * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
     4 *
     5 * This file is part of HeuristicLab.
     6 *
     7 * HeuristicLab is free software: you can redistribute it and/or modify
     8 * it under the terms of the GNU General Public License as published by
     9 * the Free Software Foundation, either version 3 of the License, or
     10 * (at your option) any later version.
     11 *
     12 * HeuristicLab is distributed in the hope that it will be useful,
     13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
     14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     15 * GNU General Public License for more details.
     16 *
     17 * You should have received a copy of the GNU General Public License
     18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
     19 */
     20#endregion
     21using System;
    222using System.Collections.Generic;
    323using System.ComponentModel;

  • trunk/sources/HeuristicLab.PluginInfrastructure/ApplicationManager.cs

    r3046 r3092  
    155155
    156156    /// <summary>
    157     /// Loads assemblies dynamically from a byte array
    158     /// </summary>
    159     /// <param name="plugins">bytearray of all assemblies that should be loaded</param>
     157    /// Loads raw assemblies dynamically from a byte array
     158    /// </summary>
     159    /// <param name="assemblies">bytearray of all raw assemblies that should be loaded</param>
    160160    internal void LoadAssemblies(IEnumerable<byte[]> assemblies) {
    161161      foreach (byte[] asm in assemblies) {
    … …  
    181181    }
    182182    /// <summary>
    183     /// Creates an instance of all types declared in assembly <param name="asm"/> that are subtypes or the same type of the specified type and declared in <paramref name="plugin"/>
     183    /// Creates an instance of all types declared in assembly <paramref name="asm"/> that are subtypes or the same type of the specified <typeparamref name="type"/>.
    184184    /// </summary>
    185185    /// <typeparam name="T">Most general type.</typeparam>
    … …  
    203203    /// Creates an instance of all types that are subtypes or the same type of the specified type
    204204    /// </summary>
    205     /// <typeparam name="type">Most general type.</typeparam>
     205    /// <param name="type">Most general type.</param>
    206206    /// <returns>Enumerable of the created instances.</returns>
    207207    internal static IEnumerable<object> GetInstances(Type type) {

  • trunk/sources/HeuristicLab.PluginInfrastructure/Attributes/ApplicationAttribute.cs

    r2790 r3092  
    7676    /// <param name="name">Name of the application</param>
    7777    /// <param name="description">Description of the application</param>
    78     /// <param name="version">Version string of the application</param>
    7978    /// <param name="restartOnErrors">Flag that indicates if the application should be restarted on exceptions (for services)</param>
    8079    /// </summary>

  • trunk/sources/HeuristicLab.PluginInfrastructure/Attributes/PluginDependencyAttribute.cs

    r2790 r3092  
    5656    }
    5757
     58    /// <summary>
     59    /// Initializes a new instance of <see cref="PluginDependencyAttribute" />.
     60    /// </summary>
     61    /// <param name="dependency">Name of the plugin dependency.</param>
     62    /// <param name="version">Version of the plugin dependency.</param>
    5863    public PluginDependencyAttribute(string dependency, string version) {
    5964      if (string.IsNullOrEmpty(dependency)) throw new ArgumentException("Dependency name is null or empty.", "dependency");

  • trunk/sources/HeuristicLab.PluginInfrastructure/Attributes/PluginFileAttribute.cs

    r2790 r3092  
    3030  /// </summary>
    3131  public enum PluginFileType {
     32    /// <summary>
     33    /// CLR assembly files are loaded by the plugin infrastructure.
     34    /// </summary>
    3235    Assembly,
     36    /// <summary>
     37    /// Native DLL files are ignored by the plugin infrastructure.
     38    /// </summary>
    3339    NativeDll,
     40    /// <summary>
     41    /// Data files are any kind of support file for your plugin.
     42    /// </summary>
    3443    Data,
     44    /// <summary>
     45    /// License files contain the license text of the plugin (ASCII encoding).
     46    /// </summary>
    3547    License
    3648  };

  • trunk/sources/HeuristicLab.PluginInfrastructure/ControlManager.cs

    r2790 r3092  
    2929
    3030namespace HeuristicLab.PluginInfrastructure {
    31 
     31  /// <summary>
     32  /// Singleton class for the ControlManager (needed by HeuristicLab 3.2)
     33  /// </summary>
    3234  public static class ControlManager {
    3335    // singleton: only one control manager allowed in each application (i.e. AppDomain)
    … …  
    4042    }
    4143
     44    /// <summary>
     45    /// Set the current control manager.
     46    /// </summary>
     47    /// <param name="manager">The control manager</param>
     48    /// <exception cref="InvalidOperationException">Throws exception when a control manager has previously been set.</exception>
    4249    public static void RegisterManager(IControlManager manager) {
    4350      if (controlManager != null) throw new InvalidOperationException("An control manager has already been set.");

  • trunk/sources/HeuristicLab.PluginInfrastructure/Interfaces/IApplication.cs

    r2790 r3092  
    2525
    2626namespace HeuristicLab.PluginInfrastructure {
     27  /// <summary>
     28  /// Interface that must be implemented by HeuristicLab applications.
     29  /// </summary>
    2730  public interface IApplication {
     31    /// <summary>
     32    /// Gets the name of the application.
     33    /// </summary>
    2834    string Name { get; }
     35    /// <summary>
     36    /// Gets the description of the application.
     37    /// </summary>
    2938    string Description { get; }
     39    /// <summary>
     40    /// Main entry point for the application.
     41    /// </summary>
    3042    void Run();
    3143  }

  • trunk/sources/HeuristicLab.PluginInfrastructure/Interfaces/IApplicationManager.cs

    r2790 r3092  
    5151    /// Discovers and creates instances of <paramref name="type"/> and all types implementing or inheriting <paramref name="type"/> (directly and indirectly).
    5252    /// </summary>
    53     /// <param name="type">The type or super-type to discover.</typeparam>
     53    /// <param name="type">The type or super-type to discover.</param>
    5454    /// <returns>An enumerable of instances of the discovered types.</returns>
    5555    IEnumerable<object> GetInstances(Type type);

  • trunk/sources/HeuristicLab.PluginInfrastructure/Main.cs

    r2916 r3092  
    2929
    3030namespace HeuristicLab.PluginInfrastructure {
     31  /// <summary>
     32  /// Static class that contains the main entry point of the plugin infrastructure.
     33  /// </summary>
    3134  public static class Main {
     35    /// <summary>
     36    /// Main entry point of the plugin infrastructure. Either loads a starter form or a console dialog.
     37    /// </summary>
     38    /// <param name="args">Command line arguments</param>
    3239    public static void Run(string[] args) {
    3340      if (args.Length == 0) {  // normal mode

  • trunk/sources/HeuristicLab.PluginInfrastructure/Manager/PluginFile.cs

    r3006 r3092  
    2727
    2828namespace HeuristicLab.PluginInfrastructure.Manager {
     29  /// <summary>
     30  /// Plugin files have a name and a type.
     31  /// </summary>
    2932  [Serializable]
    3033  public sealed class PluginFile : IPluginFile {
    … …  
    3235
    3336    private string name;
     37    /// <summary>
     38    /// Gets the name of the file.
     39    /// </summary>
    3440    public string Name {
    3541      get { return name; }
    … …  
    3743
    3844    private PluginFileType type;
     45    /// <summary>
     46    /// Gets the type of the file.
     47    /// </summary>
    3948    public PluginFileType Type {
    4049      get { return type; }
    … …  
    4352    #endregion
    4453
     54    /// <summary>
     55    /// Inizialize a new instance of <see cref="PluginFile" />
     56    /// </summary>
     57    /// <param name="name">File name</param>
     58    /// <param name="type">File type</param>
    4559    public PluginFile(string name, PluginFileType type) {
    4660      this.name = name;
    … …  
    4862    }
    4963
     64    /// <summary>
     65    /// ToString override for <see cref="PluginFile" />
     66    /// </summary>
     67    /// <returns>Plugin file name</returns>
    5068    public override string ToString() {
    5169      return name;

  • trunk/sources/HeuristicLab.PluginInfrastructure/PluginState.cs

    r2790 r3092  
    2525
    2626namespace HeuristicLab.PluginInfrastructure {
     27  /// <summary>
     28  /// Possible states that a plugin can have.
     29  /// </summary>
    2730  [Serializable]
    2831  public enum PluginState {
    29     Undefined, Enabled, Disabled, Loaded
     32    /// <summary>
     33    /// Undefined state is the default plugin state.
     34    /// </summary>
     35    Undefined,
     36    /// <summary>
     37    /// Enabled state means that the plugin has correct meta-data and can be loaded.
     38    /// </summary>
     39    Enabled,
     40    /// <summary>
     41    /// Disabled state means that the plugin has incorrect meta-data or missing dependencies and cannot be loaded.
     42    /// </summary>
     43    Disabled,
     44    /// <summary>
     45    /// Loaded means the plugin is currently loaded by an application.
     46    /// </summary>
     47    Loaded
    3048  }
    3149}

  • trunk/sources/HeuristicLab.PluginInfrastructure/Properties/Settings.Designer.cs

    r3006 r3092  
    1 //------------------------------------------------------------------------------
     1#pragma warning disable 1591
     2//------------------------------------------------------------------------------
    23// <auto-generated>
    34//     This code was generated by a tool.
    … …  
    9192    }
    9293}
     94#pragma warning restore 1591

  • trunk/sources/HeuristicLab.PluginInfrastructure/Starter/StarterForm.cs

    r2922 r3092  
    3636
    3737namespace HeuristicLab.PluginInfrastructure.Starter {
     38  /// <summary>
     39  /// The starter form is responsible for initializing the plugin infrastructure
     40  /// and shows a list of installed applications.
     41  /// </summary>
    3842  public partial class StarterForm : Form {
    3943
    … …  
    4246    private PluginManager pluginManager;
    4347
     48    /// <summary>
     49    /// Initializes an instance of the starter form.
     50    /// The starter form shows a splashscreen and initializes the plugin infrastructure.
     51    /// </summary>
    4452    public StarterForm()
    4553      : base() {
    … …  
    7482    }
    7583
     84    /// <summary>
     85    /// Creates a new StarterForm and tries to start application with <paramref name="appName"/> immediately.
     86    /// </summary>
     87    /// <param name="appName">Name of the application</param>
    7688    public StarterForm(string appName)
    7789      : this() {

  • trunk/sources/HeuristicLab.Services.Deployment/3.3/Tests/PluginStoreTest.cs

    r3088 r3092  
    175175          Assert.Fail("persist should fail with ArgumentException");
    176176        }
    177         catch (ArgumentException e) {
     177        catch (ArgumentException) {
    178178          // this is expected
    179179          Assert.IsTrue(true, "expected exception");
    … …  
    328328          Assert.Fail("persist should fail with ArgumentException");
    329329        }
    330         catch (ArgumentException e) {
     330        catch (ArgumentException) {
    331331          // this is expected
    332332          Assert.IsTrue(true, "expected exception");
Note: See TracChangeset for help on using the changeset viewer.