Add inline doc to Compute Api

Author: carolynvs

src/corelib/Compute/v2_1/FlavorExtensions.cs

@@ -4,7 +4,9 @@
 // ReSharper disable once CheckNamespace
 namespace OpenStack.Synchronous
 {
-    /// <summary />
+    /// <summary>
+    /// Provides synchronous extention methods for a <see cref="Flavor"/> instance.
+    /// </summary>
     public static class FlavorExtensions_v2_1
     {
         /// <inheritdoc cref="FlavorReference.GetFlavorAsync"/>

src/corelib/Compute/v2_1/FlavorSummary.cs

@@ -2,7 +2,9 @@
 
 namespace OpenStack.Compute.v2_1
 {
-    /// <summary />
+    /// <summary>
+    /// Summary information for a flavor.
+    /// </summary>
     public class FlavorSummary : FlavorReference
     {
         /// <summary>

src/corelib/Compute/v2_1/ImageExtensions.cs

@@ -5,7 +5,9 @@
 // ReSharper disable once CheckNamespace
 namespace OpenStack.Synchronous
 {
-    /// <summary />
+    /// <summary>
+    /// Provides synchronous extention methods for a <see cref="Image"/> instance.
+    /// </summary>
     public static class ImageExtensions_v2_1
     {
         /// <inheritdoc cref="ImageReference.GetImageAsync"/>

src/corelib/Compute/v2_1/ImageMetadataExtensions.cs

@@ -4,7 +4,9 @@
 // ReSharper disable once CheckNamespace
 namespace OpenStack.Synchronous
 {
-    /// <summary />
+    /// <summary>
+    /// Provides synchronous extention methods for a <see cref="ImageMetadata"/> instance.
+    /// </summary>
     public static class ImageMetadataExtensions_v2_1
     {
         /// <inheritdoc cref="ImageMetadata.CreateAsync"/>

src/corelib/Compute/v2_1/ImageSummary.cs

@@ -3,7 +3,7 @@
 namespace OpenStack.Compute.v2_1
 {
     /// <summary>
-    /// Summary data for an image.
+    /// Summary information for an image.
     /// </summary>
     public class ImageSummary : ImageReference
     {

src/corelib/Compute/v2_1/KeyPairDefinition.cs

@@ -4,7 +4,7 @@
 namespace OpenStack.Compute.v2_1
 {
     /// <summary>
-    /// Defines a key pair which can be imported into the compute service.
+    /// Defines an existing public key.
     /// </summary>
     [JsonConverter(typeof(KeyPairConverter))]
     public class KeyPairDefinition
@@ -20,15 +20,11 @@ public KeyPairDefinition(string name, string publicKey)
             PublicKey = publicKey;
         }
 
-        /// <summary>
-        /// The key pair name.
-        /// </summary>
+        /// <inheritdoc cref="KeyPairSummary.Name" />
         [JsonProperty("name")]
         public string Name { get; set; }
 
-        /// <summary>
-        /// The public ssh key to import.
-        /// </summary>
+        /// <inheritdoc cref="KeyPairSummary.PublicKey" />
         [JsonProperty("public_key")]
         public string PublicKey { get; set; }
     }

src/corelib/Compute/v2_1/KeyPairExtensions.cs

@@ -4,7 +4,9 @@
 // ReSharper disable once CheckNamespace
 namespace OpenStack.Synchronous
 {
-    /// <summary />
+    /// <summary>
+    /// Provides synchronous extention methods for a <see cref="KeyPair"/> instance.
+    /// </summary>
     public static class KeypairExtensions_v2_1
     {
         /// <inheritdoc cref="KeyPairSummary.DeleteAsync" />

src/corelib/Compute/v2_1/RemoteConsoleType.cs

@@ -2,9 +2,7 @@
 
 namespace OpenStack.Compute.v2_1
 {
-    /// <summary>
-    /// The remote console type
-    /// </summary>
+    /// <inheritdoc />
     public class RemoteConsoleType : RemoteConsoleType<RemoteConsoleType>
     {
     }

src/corelib/Compute/v2_1/SchedulerHints.cs

@@ -5,7 +5,12 @@
 
 namespace OpenStack.Compute.v2_1
 {
-    /// <summary />
+    /// <summary>
+    /// Hints passed to the compute scheduler when creating a server.
+    /// <para>These may be used by the scheduler to determine how and where the server instance is created.</para>
+    /// <para>Custom hints can be set via the <see cref="Add"/> method.</para>
+    /// </summary>
+    /// <seealso href="http://docs.openstack.org/developer/nova/filter_scheduler.html"/>
     public class SchedulerHints : IHaveExtraData
     {
         /// <summary />
@@ -15,29 +20,43 @@ public SchedulerHints()
             SameHost = new List<string>();
         }
 
-        /// <summary />
+        /// <summary>
+        /// Specifies a custom filter by passing a scheduler hint in JSON format.
+        /// </summary>
+        /// <seealso href="http://docs.openstack.org/liberty/config-reference/content/section_compute-scheduler.html#jsonfilter"/>
         [JsonProperty("query")]
         public string Query { get; set; }
 
-        /// <summary />
+        /// <summary>
+        /// Schedules the instance based on host IP subnet range. Specifies the CIDR that corresponds to the subnet.
+        /// <para>Must also specify <see cref="BuildNearHostIP"/>.</para>
+        /// </summary>
         [JsonProperty("build_near_host_ip")]
         public string BuildNearHostIP { get; set; }
 
         /// <summary>
-        /// Classless Inter-Domain Routing (CIDR). A method for allocating IP addresses and routing Internet Protocol packets.
+        /// Schedules the instance based on host IP subnet range. Specifies the first IP address in the subnet.
+        /// <para>Must also specify <see cref="BuildNearHostIP"/>.</para>
         /// </summary>
         [JsonProperty("cidr")]
         public string CIDR { get; set; }
 
-        /// <summary />
+        /// <summary>
+        /// Schedules the instance on a different host from a set of instances.
+        /// </summary>
         [JsonProperty("different_host")]
         public IList<string> DifferentHost { get; set; }
 
-        /// <summary />
+        /// <summary>
+        /// Schedules the instance on the same host as another instance in a set of instances.
+        /// </summary>
         [JsonProperty("same_host")]
         public IList<string> SameHost { get; set; }
 
-        /// <summary />
+        /// <summary>
+        /// Specifies additional custom hints to pass to the scheduler.
+        /// <para>Use the <see cref="Add"/> method instead of accessing this property directly.</para>
+        /// </summary>
         [JsonExtensionData]
         public IDictionary<string, JToken> Data { get; set; } = new Dictionary<string, JToken>();
 

src/corelib/Compute/v2_1/SecurityGroup.cs

@@ -9,25 +9,36 @@
 
 namespace OpenStack.Compute.v2_1
 {
-    /// <summary />
+    /// <summary>
+    /// Security groups are sets of IP filter rules that are applied to an instance's networking.
+    /// </summary>
+    /// <seealso href="http://docs.openstack.org/openstack-ops/content/security_groups.html"/>
     [JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_group")]
     public class SecurityGroup : SecurityGroupReference
     {
-        /// <summary />
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SecurityGroup"/> class.
+        /// </summary>
         public SecurityGroup()
         {
             Rules = new List<SecurityGroupRule>();
         }
 
-        /// <summary />
+        /// <summary>
+        /// The security group identifier.
+        /// </summary>
         [JsonProperty("id")]
         public Identifier Id { get; set; }
 
-        /// <summary />
+        /// <summary>
+        /// The security group description.
+        /// </summary>
         [JsonProperty("description")]
         public string Description { get; set; }
 
-        /// <summary />
+        /// <summary>
+        /// The security group rules.
+        /// </summary>
         [JsonProperty("rules")]
         public IList<SecurityGroupRule> Rules { get; set; }