Add XML documentation comments to public APIs

[Copilot]

Adds missing XML documentation comments to resolve CS1591 warnings for publicly visible types and members. Documentation follows the pattern of defining comments on interfaces and using <inheritdoc /> in implementations.

Changes

Service Interfaces

• IAuditService, IEmissionsService, ICrawlService - Added method and parameter documentation
• IAuditIssue, IAuditPageIssue, IAuditImageIssue - Added property and method documentation

Service Implementations

• AuditService, EmissionsService, CrawlService - Applied <inheritdoc /> pattern
• Fixed CS1572 warning in EmissionsService by removing non-existent version parameter

Audit Issues

• All 11 implementations now use <inheritdoc /> for interface members

Schema Classes

• TechnicalSeoSchema, SocialMediaSchema, SeoSchema, PageSchema - Added class-level and property documentation
• Options (SchemaGenerator) - Added documentation

Example

/// <summary>
/// Service for calculating carbon emissions and energy consumption of web pages
/// </summary>
public interface IEmissionsService
{
    /// <summary>
    /// Calculate carbon emissions per byte of data transfer
    /// </summary>
    /// <param name="bytes">Number of bytes transferred</param>
    /// <param name="green">Whether the hosting uses green energy</param>
    EmissionResult PerByte(double bytes, bool green = false);
}

/// <inheritdoc />
public class EmissionsService : IEmissionsService
{
    /// <inheritdoc />
    public EmissionResult PerByte(double bytes, bool green = false) { ... }
}

Note: Generated files (*.generated.cs) remain undocumented per requirements.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• www.myget.org
  • Triggering command: /usr/bin/dotnet dotnet build (dns block)
  • Triggering command: /usr/bin/dotnet dotnet run --configuration Debug -- --outputFile /home/REDACTED/work/ContentAudit/ContentAudit/src/Umbraco.Community.ContentAudit/appsettings-schema.ContentAudit.json (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

Run a dotnet build and check all the warnings for missing XML comments. Add comments where appropriate, but not in *.generated.cs files.

Where a service is inheriting from an interface, move the comment to the interface and use <inheritdoc />

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud