Free cookie consent management tool by TermsFeed Policy Generator

Ignore:
Timestamp:
03/17/10 19:01:27 (15 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/HeuristicLab.PluginInfrastructure/Advanced
Files:
7 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;
Note: See TracChangeset for help on using the changeset viewer.