Skip to content

Commit

Permalink
Fix remaining doc comment bullets (#2285)
Browse files Browse the repository at this point in the history
  • Loading branch information
David R. Williamson authored Jan 14, 2022
1 parent cbbad60 commit 313d885
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 12 deletions.
14 changes: 9 additions & 5 deletions provisioning/service/src/Config/QueryResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,26 @@ namespace Microsoft.Azure.Devices.Provisioning.Service
/// <remarks>
/// It is the result of any query for the provisioning service. This class will parse the result and
/// return it in a best format possible. For the known formats in <see cref="QueryResultType"/>, you can
/// just cast the items. In case of <b>unknown</b> type, the items will contain a list of <code>string</code>
/// just cast the items. In case of <b>unknown</b> type, the items will contain a list of <c>string</c>
/// and you shall parse it by your own.
///
/// The provisioning service query result is composed by 2 system properties and a body. This class exposes
/// it with 3 getters, <see cref="Type"/>, <see cref="Items"/>, and <see cref="ContinuationToken"/>.
///
/// The system properties are:
/// <list type="bullet">
/// <item><b>type:</b>
/// <item>
/// <description><b>type:</b>
/// Identify the type of the content in the body. You can use it to cast the objects
/// in the items list. See <see cref="QueryResultType"/> for the possible types and classes
/// to cast.</item>
/// <item><b>continuationToken:</b>
/// to cast.</description>
/// </item>
/// <item>
/// <description><b>continuationToken:</b>
/// Contains the token the uniquely identify the next page of information. The
/// service will return the next page of this query when you send a new query with
/// this token.</item>
/// this token.</description>
/// </item>
/// </list>
///
/// And the body is a JSON list of the specific <b>type</b>. For instance, if the system
Expand Down
20 changes: 13 additions & 7 deletions provisioning/service/src/Config/X509Attestation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,20 @@ namespace Microsoft.Azure.Devices.Provisioning.Service
/// An X509 attestation can contains one of the 3 types of certificate:
///
/// <list type="bullet">
/// <item><b>Client or Alias certificate:</b>
/// Called on this class as clientCertificates, this certificate can authenticate a single device.</item>
/// <item><b>Signing or Root certificate:</b>
/// <item>
/// <description><b>Client or Alias certificate:</b>
/// Called on this class as clientCertificates, this certificate can authenticate a single device.</description>
/// </item>
/// <item>
/// <description><b>Signing or Root certificate:</b>
/// Called on this class as rootCertificates, this certificate can create multiple Client certificates
/// to authenticate multiple devices.</item>
/// <item><b>CA Reference:</b>
/// to authenticate multiple devices.</description>
/// </item>
/// <item>
/// <description><b>CA Reference:</b>
/// Called on this class as X509CAReferences, this is a CA reference for a rootCertificate that can
/// creates multiple Client certificates to authenticate multiple devices.</item>
/// creates multiple Client certificates to authenticate multiple devices.</description>
/// </item>
/// </list>
///
/// The provisioning service allows user to create <see cref="IndividualEnrollment"/> and <see cref="EnrollmentGroup"/>.
Expand All @@ -38,7 +44,7 @@ namespace Microsoft.Azure.Devices.Provisioning.Service
/// primary is mandatory, the secondary is optional.
///
/// The provisioning service will process the provided certificates, but will never return it back. Instead of
/// it, <see cref="X509Attestation.GetPrimaryX509CertificateInfo()"/> and <see cref="X509Attestation.GetSecondaryX509CertificateInfo()"/>
/// it, <see cref="GetPrimaryX509CertificateInfo()"/> and <see cref="GetSecondaryX509CertificateInfo()"/>
/// will return the certificate information for the certificates.
/// </remarks>
public sealed class X509Attestation : Attestation
Expand Down

0 comments on commit 313d885

Please sign in to comment.