Changeset 3092 for trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/DeploymentService

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/DeploymentService

Files:

• AdminClientFactory.cs (modified) (2 diffs)
• DeploymentService.cs (modified) (2 diffs)
• PluginDescription.cs (modified) (5 diffs)
• ProductDescription.cs (modified) (1 diff)
• UpdateClientFactory.cs (modified) (2 diffs)

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

@@ -8 +8 @@
 
 namespace HeuristicLab.PluginInfrastructure.Advanced.DeploymentService {
+  /// <summary>
+  /// Factory class to generated administration client instances for the deployment service.
+  /// </summary>
   public static class AdminClientFactory {
     private static byte[] serverCrtData;
 
+    /// <summary>
+    /// static constructor loads the embedded service certificate 
+    /// </summary>
     static AdminClientFactory() {
       var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream("HeuristicLab.PluginInfrastructure.Advanced.DeploymentService.servdev.cer");
@@ -17 +23 @@
     }
 
+    /// <summary>
+    /// Factory method to create new administration clients for the deployment service.
+    /// Sets the connection string and user credentials from values provided in settings.
+    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationUserName
+    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationPassword
+    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationnAdministrationAddress
+    /// 
+    /// </summary>
+    /// <returns>A new instance of an adimistration client</returns>
     public static AdminClient CreateClient() {
       var client = new AdminClient();

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

@@ -1 @@
-//------------------------------------------------------------------------------
+#pragma warning disable 1591
+//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by a tool.
@@ -313 +314 @@
     }
 }
+#pragma warning restore 1591

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

@@ -32 +32 @@
   // extension of auto-generated DataContract class PluginDescription
   public partial class PluginDescription : IPluginDescription {
+    /// <summary>
+    /// Initializes an new instance of <see cref="PluginDescription" />
+    /// with no dependencies, empty contact details and empty license text.
+    /// </summary>
+    /// <param name="name">Name of the plugin</param>
+    /// <param name="version">Version of the plugin</param>
     public PluginDescription(string name, Version version) : this(name, version, new List<PluginDescription>()) { }
+    /// <summary>
+    /// Initializes a new instance of <see cref="PluginDescription" /> 
+    /// with empty contact details and empty license text.
+    /// </summary>
+    /// <param name="name">Name of the plugin</param>
+    /// <param name="version">Version of the plugin</param>
+    /// <param name="dependencies">Enumerable of dependencies of the plugin</param>
     public PluginDescription(string name, Version version, IEnumerable<PluginDescription> dependencies)
       : this(name, version, dependencies, string.Empty, string.Empty, string.Empty) {
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="PluginDescription" />.
+    /// </summary>
+    /// <param name="name">Name of the plugin</param>
+    /// <param name="version">Version of the plugin</param>
+    /// <param name="dependencies">Enumerable of dependencies of the plugin</param>
+    /// <param name="contactName">Name of the contact person for the plugin</param>
+    /// <param name="contactEmail">E-mail of the contact person for the plugin</param>
+    /// <param name="licenseText">License text for the plugin</param>
     public PluginDescription(string name, Version version, IEnumerable<PluginDescription> dependencies, string contactName, string contactEmail, string licenseText) {
       this.Name = name;
@@ -45 +67 @@
 
     #region IPluginDescription Members
+    /// <summary>
+    /// Gets the description of the plugin. Always string.Empty.
+    /// </summary>
     public string Description {
       get { return string.Empty; }
@@ -54 +79 @@
     }
 
+    /// <summary>
+    /// Gets an enumerable of dependencies of the plugin
+    /// </summary>
     IEnumerable<IPluginDescription> IPluginDescription.Dependencies {
       get {
@@ -60 +88 @@
     }
 
+    /// <summary>
+    /// Gets and enumerable of files that are part of this pluing. Always empty.
+    /// </summary>
     public IEnumerable<IPluginFile> Files {
       get { return Enumerable.Empty<IPluginFile>(); }
@@ -66 +97 @@
     #endregion
 
+    /// <summary>
+    /// ToString override
+    /// </summary>
+    /// <returns>String representation of the PluginDescription (name + version)</returns>
     public override string ToString() {
       return Name + " " + Version;

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

@@ -31 +31 @@
 namespace HeuristicLab.PluginInfrastructure.Advanced.DeploymentService {
   // extension of auto-generated DataContract class ProductDescription
+  /// <summary>
+  /// Product description as provided by the deployment service.
+  /// A product has a name, a version and a list of plugins that are part of the product.
+  /// </summary>
   public partial class ProductDescription  {
+    /// <summary>
+    /// Initializes a new instance of <see cref="ProductDescription" />
+    /// </summary>
+    /// <param name="name">Name of the product</param>
+    /// <param name="version">Version of the product</param>
     public ProductDescription(string name, Version version)
       : this(name, version, new List<PluginDescription>()) {
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ProductDescription" />
+    /// </summary>
+    /// <param name="name">Name of the product</param>
+    /// <param name="version">Version of the product</param>
+    /// <param name="plugins">Enumerable of plugins of the product</param>
     public ProductDescription(string name, Version version, IEnumerable<PluginDescription> plugins) {
       this.Name = name;

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

@@ -8 +8 @@
 
 namespace HeuristicLab.PluginInfrastructure.Advanced.DeploymentService {
+  /// <summary>
+  /// Factory class to generated update client instances for the deployment service.
+  /// </summary>
   public static class UpdateClientFactory {
     private static byte[] serverCrtData;
 
+    /// <summary>
+    /// static constructor loads the embedded service certificate 
+    /// </summary>
     static UpdateClientFactory() {
       var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream("HeuristicLab.PluginInfrastructure.Advanced.DeploymentService.servdev.cer");
@@ -17 +23 @@
     }
 
+    /// <summary>
+    /// Factory method to create new update clients for the deployment service.
+    /// Sets the connection string and user credentials from values provided in settings.
+    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationUserName
+    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocationPassword
+    /// HeuristicLab.PluginInfrastructure.Properties.Settings.Default.UpdateLocation
+    /// 
+    /// </summary>
+    /// <returns>A new instance of an update client</returns>
     public static UpdateClient CreateClient() {
       var client = new UpdateClient();