Skip doc generation for vendor/serialization classes

Author: carolynvs

src/corelib/OpenStackNet.cs

@@ -266,10 +266,16 @@ private void SetUserAgentHeader(HttpCall call)
             }
         }
 
-        /// <summary />
+        /// <summary>
+        /// Raised when creating the SDK configuration options class.
+        /// <para>Intended for vendors to override.</para>
+        /// </summary>
+        /// <exclude />
         public class CreateEvent
         {
-            /// <summary />
+            /// <summary>
+            /// An instance of the configuration class to use when configuring the SDK.
+            /// </summary>
             public OpenStackNetConfigurationOptions Result = new OpenStackNetConfigurationOptions();
         }
     }

src/corelib/PageOptions.cs

@@ -3,13 +3,19 @@
 
 namespace OpenStack
 {
-    /// <summary />
+    /// <summary>
+    /// Paging options when listing a resource that supports paging.
+    /// </summary>
     public class PageOptions : IQueryStringBuilder
     {
-        /// <summary />
+        /// <summary>
+        /// The number of resources to return per page.
+        /// </summary>
         public int? PageSize { get; set; }
 
-        /// <summary />
+        /// <summary>
+        /// The identifier of the first resource to return on the page.
+        /// </summary>
         public Identifier StartingAt { get; set; }
 
         /// <summary />

src/corelib/Serialization/IHaveExtraData.cs

@@ -3,17 +3,27 @@
 
 namespace OpenStack.Serialization
 {
-    /// <summary />
+    /// <summary>
+    /// Identifies a resource as potentially containing more data than what is exposed via properties.
+    /// </summary>
+    /// <exclude />
     public interface IHaveExtraData
     {
-        /// <summary />
+        /// <summary>
+        /// Contains any additional data returned from the cloud provider which has not already been mapped to a property.
+        /// </summary>
         IDictionary<string, JToken> Data { get; set; }
     }
 
-    /// <summary />
+    /// <summary>
+    /// Provides convenience methods for working with custom resource properties.
+    /// </summary>
+    /// <exclude />
     public static class IHaveExtraDataExtensions
     {
-        /// <summary />
+        /// <summary>
+        /// Get a custom resource property.
+        /// </summary>
         public static T GetExtraData<T>(this IHaveExtraData dataContainer, string key)
             where T : class
         {
@@ -24,7 +34,9 @@ public static T GetExtraData<T>(this IHaveExtraData dataContainer, string key)
             return null;
         }
 
-        /// <summary />
+        /// <summary>
+        /// Sets a custom resource property.
+        /// </summary>
         public static void SetExtraData(this IHaveExtraData dataContainer, string key, object value)
         {
             dataContainer.Data[key] = value != null ? JToken.FromObject(value) : JValue.CreateNull();

src/corelib/Serialization/IPageBuilder.cs

@@ -5,7 +5,7 @@
 
 namespace OpenStack.Serialization
 {
-    /// <summary />
+    /// <exclude />
     public interface IPageBuilder<TPage>
     {
         /// <summary>

src/corelib/Serialization/IPageLink.cs

@@ -1,6 +1,6 @@
 namespace OpenStack.Serialization
 {
-    /// <summary />
+    /// <exclude />
     public interface IPageLink
     {
         /// <summary />

src/corelib/Serialization/IQueryStringBuilder.cs

@@ -2,7 +2,7 @@
 
 namespace OpenStack.Serialization
 {
-    /// <summary />
+    /// <exclude />
     public interface IQueryStringBuilder
     {
         /// <summary />

src/corelib/Serialization/IServiceResource.cs

@@ -10,6 +10,7 @@ namespace OpenStack.Serialization
     /// Resources which want to expose service operations directly (e.g. resource.Delete())
     /// should implement this interface and the service will use it to add a reference to itself.
     /// </summary>
+    /// <exclude />
     public interface IServiceResource
     {
         /// <summary>
@@ -21,6 +22,7 @@ public interface IServiceResource
     /// <summary>
     /// Resources which are children of another resource.
     /// </summary>
+    /// <exclude />
     public interface IChildResource : IServiceResource
     {
         /// <summary>
@@ -34,14 +36,14 @@ public interface IChildResource : IServiceResource
         void SetParent(string parentId);
     }
 
-    /// <summary />
+    /// <exclude />
     public static class ServiceResourceExtensions
     {
         /// <summary />
         public static async Task<T> PropogateOwner<T>(this Task<T> task, object owner)
             where T : IServiceResource
         {
-            T resource = await task;
+            T resource = await task.ConfigureAwait(false);
             return PropogateOwner(resource, owner);
         }
 
@@ -77,7 +79,7 @@ public static T PropogateOwner<T>(this T resource, object owner)
         public static async Task<T> PropogateOwnerToChildren<T>(this Task<T> task, object owner)
             where T : IEnumerable<IServiceResource>
         {
-            T resources = await task;
+            T resources = await task.ConfigureAwait(false);
             return resources.PropogateOwnerToChildren(owner);
         }
 
@@ -109,7 +111,7 @@ public static T GetOwnerOrThrow<T>(this IServiceResource resource, [CallerMember
         public static async Task<T> SetParent<T>(this Task<T> task, string parentId)
             where T : IChildResource
         {
-            var resource = await task;
+            var resource = await task.ConfigureAwait(false);
             resource.SetParent(parentId);
             return resource;
         }
@@ -118,7 +120,7 @@ public static async Task<T> SetParent<T>(this Task<T> task, string parentId)
         public static async Task<T> SetParentOnChildren<T>(this Task<T> task, string parentId)
             where T : IEnumerable<IChildResource>
         {
-            var resources = await task;
+            var resources = await task.ConfigureAwait(false);
             return SetParentOnChildren(resources, parentId);
         }
 

src/corelib/Serialization/PageLink.cs

@@ -4,7 +4,7 @@
 
 namespace OpenStack.Serialization
 {
-    /// <summary />
+    /// <exclude />
     public class PageLink : IPageLink, IHaveExtraData
     {
         /// <summary />

src/corelib/Serialization/ResourceStatus.cs

@@ -1,6 +1,6 @@
 namespace OpenStack.Serialization
 {
-    /// <summary />
+    /// <exclude />
     public class ResourceStatus : StringEnumeration
     {
         /// <summary />

src/corelib/Serialization/StringEnumeration.cs

@@ -10,6 +10,7 @@ namespace OpenStack.Serialization
     /// Using classes for enumerations allows us to use inheritance and enable API versions or other providers to share and extend "enums"
     /// <seealso href="https://lostechies.com/jimmybogard/2008/08/12/enumeration-classes/"/>
     /// </summary>
+    /// <exclude />
     [JsonConverter(typeof(StringEnumerationConverter))]
     public abstract class StringEnumeration : IComparable
     {