Skip to content

Commit a89becf

Browse files
thomhurstclaude
andauthored
docs: Add XML documentation to ICertificates interface (#1729)
Fixes #1530 Added comprehensive XML documentation for: - Interface summary describing certificate retrieval functionality - GetCertificateBySubject method with parameter and return docs - GetCertificateByThumbprint method with parameter and return docs - GetCertificateBySerialNumber method with parameter and return docs - GetCertificateBy method with parameter and return docs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c4a95b8 commit a89becf

1 file changed

Lines changed: 31 additions & 3 deletions

File tree

src/ModularPipelines/Context/ICertificates.cs

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,41 @@
22

33
namespace ModularPipelines.Context;
44

5+
/// <summary>
6+
/// Provides functionality for retrieving X.509 certificates from the certificate store.
7+
/// </summary>
58
public interface ICertificates
69
{
7-
public X509Certificate2? GetCertificateBySubject(StoreLocation storeLocation, string subject);
10+
/// <summary>
11+
/// Gets a certificate by its subject name.
12+
/// </summary>
13+
/// <param name="storeLocation">The store location to search.</param>
14+
/// <param name="subject">The subject name to search for.</param>
15+
/// <returns>The matching certificate, or null if not found.</returns>
16+
X509Certificate2? GetCertificateBySubject(StoreLocation storeLocation, string subject);
817

9-
public X509Certificate2? GetCertificateByThumbprint(StoreLocation storeLocation, string thumbprint);
18+
/// <summary>
19+
/// Gets a certificate by its thumbprint.
20+
/// </summary>
21+
/// <param name="storeLocation">The store location to search.</param>
22+
/// <param name="thumbprint">The thumbprint to search for.</param>
23+
/// <returns>The matching certificate, or null if not found.</returns>
24+
X509Certificate2? GetCertificateByThumbprint(StoreLocation storeLocation, string thumbprint);
1025

11-
public X509Certificate2? GetCertificateBySerialNumber(StoreLocation storeLocation, string serialNumber);
26+
/// <summary>
27+
/// Gets a certificate by its serial number.
28+
/// </summary>
29+
/// <param name="storeLocation">The store location to search.</param>
30+
/// <param name="serialNumber">The serial number to search for.</param>
31+
/// <returns>The matching certificate, or null if not found.</returns>
32+
X509Certificate2? GetCertificateBySerialNumber(StoreLocation storeLocation, string serialNumber);
1233

34+
/// <summary>
35+
/// Gets a certificate using a custom find type and value.
36+
/// </summary>
37+
/// <param name="storeLocation">The store location to search.</param>
38+
/// <param name="findType">The type of search to perform.</param>
39+
/// <param name="findValue">The value to search for.</param>
40+
/// <returns>The matching certificate, or null if not found.</returns>
1341
X509Certificate2? GetCertificateBy(StoreLocation storeLocation, X509FindType findType, string findValue);
1442
}

0 commit comments

Comments
 (0)