Skip to content

Commit e99f349

Browse files
committed
Merge pull request #189 from sharwell/DocsPolish
Docs polish
2 parents 0d98ba0 + 475cad7 commit e99f349

174 files changed

Lines changed: 554 additions & 213 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/TraceAndTestImpact.testsettings

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@
2727
<DataCollectors>
2828
<DataCollector uri="datacollector://microsoft/SystemInfo/1.0" assemblyQualifiedName="Microsoft.VisualStudio.TestTools.DataCollection.SystemInfo.SystemInfoDataCollector, Microsoft.VisualStudio.TestTools.DataCollection.SystemInfo, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" friendlyName="System Information">
2929
</DataCollector>
30-
<DataCollector uri="datacollector://microsoft/HttpProxy/1.0" assemblyQualifiedName="Microsoft.VisualStudio.TraceCollector.HttpProxyCollector, Microsoft.VisualStudio.TraceCollector, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" friendlyName="ASP.NET Client Proxy for IntelliTrace and Test Impact">
31-
</DataCollector>
3230
<DataCollector uri="datacollector://microsoft/TestImpact/1.0" assemblyQualifiedName="Microsoft.VisualStudio.TraceCollector.TestImpactDataCollector, Microsoft.VisualStudio.TraceCollector, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" friendlyName="Test Impact">
3331
</DataCollector>
3432
<DataCollector uri="datacollector://microsoft/TraceDebugger/1.0" assemblyQualifiedName="Microsoft.VisualStudio.TraceCollector.TraceDebuggerDataCollector, Microsoft.VisualStudio.TraceCollector, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" friendlyName="IntelliTrace">

src/corelib/Core/Domain/CloudIdentity.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
/// Represents a set of credentials used for accessing a cloud account. Individual providers
55
/// may impose restrictions on the values allowed for individual properties.
66
/// </summary>
7+
/// <threadsafety static="true" instance="false"/>
78
public class CloudIdentity
89
{
910
/// <summary>

src/corelib/Core/Domain/CloudNetwork.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
/// Represents the detailed information for a labeled network in Rackspace Cloud Networks.
77
/// </summary>
88
/// <seealso href="http://docs.rackspace.com/networks/api/v2/cn-devguide/content/ch_overview.html">Overview (Rackspace Cloud Networks Developer Guide - OpenStack Networking API v2)</seealso>
9+
/// <threadsafety static="true" instance="false"/>
910
[JsonObject(MemberSerialization.OptIn)]
1011
public class CloudNetwork
1112
{

src/corelib/Core/Domain/Container.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
/// <seealso cref="IObjectStorageProvider"/>
1010
/// <seealso href="http://docs.openstack.org/api/openstack-object-storage/1.0/content/s_serializedlistoutput.html">Serialized List Output (OpenStack Object Storage API v1 Reference)</seealso>
1111
/// <seealso href="http://docs.rackspace.com/files/api/v1/cf-devguide/content/Format_Container_List-d1e124.html">Format Container List (Rackspace Cloud Files Developer Guide - API v1)</seealso>
12+
/// <threadsafety static="true" instance="false"/>
1213
[JsonObject(MemberSerialization.OptIn)]
1314
public class Container
1415
{

src/corelib/Core/Domain/ContainerCDN.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
/// </note>
1313
/// </remarks>
1414
/// <seealso href="http://docs.rackspace.com/files/api/v1/cf-devguide/content/CDN_Container_Services-d1e2632.html">CDN Container Services (Rackspace Cloud Files Developer Guide - API v1)</seealso>
15+
/// <threadsafety static="true" instance="false"/>
1516
[JsonObject(MemberSerialization.OptIn)]
1617
public class ContainerCDN
1718
{

src/corelib/Core/Domain/ContainerObject.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
/// <summary>
77
/// Provides the details of an object stored in an Object Storage provider.
88
/// </summary>
9+
/// <threadsafety static="true" instance="false"/>
910
[JsonObject(MemberSerialization.OptIn)]
1011
public class ContainerObject
1112
{

src/corelib/Core/Domain/Converters/IPAddressDetailsConverter.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
/// </summary>
1616
/// <seealso href="http://docs.openstack.org/api/openstack-compute/2/content/List_Addresses-d1e3014.html">List Addresses (OpenStack Compute API v2 and Extensions Reference)</seealso>
1717
/// <seealso href="http://docs.openstack.org/api/openstack-compute/2/content/List_Addresses_by_Network-d1e3118.html">List Addresses by Network (OpenStack Compute API v2 and Extensions Reference)</seealso>
18+
/// <threadsafety static="true" instance="false"/>
1819
public class IPAddressDetailsConverter : JsonConverter
1920
{
2021
/// <remarks>
@@ -69,6 +70,7 @@ public override bool CanConvert(Type objectType)
6970
/// </summary>
7071
/// <seealso cref="IComputeProvider.ListAddresses"/>
7172
/// <seealso cref="IComputeProvider.ListAddressesByNetwork"/>
73+
/// <threadsafety static="true" instance="false"/>
7274
[JsonObject(MemberSerialization.OptIn)]
7375
private class AddressDetails
7476
{

src/corelib/Core/Domain/Converters/IPAddressSimpleConverter.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
/// </summary>
1212
/// <seealso href="http://docs.openstack.org/api/openstack-compute/2/content/List_Addresses-d1e3014.html">List Addresses (OpenStack Compute API v2 and Extensions Reference)</seealso>
1313
/// <seealso href="http://docs.openstack.org/api/openstack-compute/2/content/List_Addresses_by_Network-d1e3118.html">List Addresses by Network (OpenStack Compute API v2 and Extensions Reference)</seealso>
14+
/// <threadsafety static="true" instance="false"/>
1415
public class IPAddressSimpleConverter : SimpleStringJsonConverter<IPAddress>
1516
{
1617
/// <remarks>
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
namespace net.openstack.Core.Domain.Converters
2+
{
3+
using System.Net;
4+
using System.Net.NetworkInformation;
5+
using System.Runtime.CompilerServices;
6+
7+
/// <summary>
8+
/// The <see cref="net.openstack.Core.Domain.Converters"/> namespace defines specialized
9+
/// JSON converters for calling the OpenStack REST APIs. These converters are useful for
10+
/// standard .NET classes that have a one or more specific representations in the
11+
/// OpenStack APIs (e.g. <see cref="IPAddress"/> or <see cref="PhysicalAddress"/>), and
12+
/// for extensible enumerations (e.g. <see cref="ServerState"/>).
13+
/// </summary>
14+
[CompilerGenerated]
15+
internal class NamespaceDoc
16+
{
17+
}
18+
}

src/corelib/Core/Domain/Converters/PhysicalAddressSimpleConverter.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
/// <literal>00:11:22:33:44:55</literal>, and deserialization supports representations
1212
/// using hyphens or colons, along with bare strings containing 12 hexadecimal digits.
1313
/// </summary>
14+
/// <threadsafety static="true" instance="false"/>
1415
public class PhysicalAddressSimpleConverter : SimpleStringJsonConverter<PhysicalAddress>
1516
{
1617
private static readonly Regex Ieee802Expression =

0 commit comments

Comments
 (0)