Skip to content

docs: Add interface and class documentation#1658

Merged
thomhurst merged 2 commits into
mainfrom
fix/interface-docs
Dec 30, 2025
Merged

docs: Add interface and class documentation#1658
thomhurst merged 2 commits into
mainfrom
fix/interface-docs

Conversation

@thomhurst
Copy link
Copy Markdown
Owner

Summary

  • Add class-level XML documentation for ICommand interface describing it as the core abstraction for executing command line tools and processes
  • Add class-level XML documentation for AzureExtensions class with summary and remarks about using context.Azure()
  • Add method-level documentation for the public RegisterAzureContext extension method

Test plan

  • Build ModularPipelines.csproj - verified success
  • Build ModularPipelines.Azure.csproj - verified success

Closes #1650
Closes #1621

🤖 Generated with Claude Code

thomhurst and others added 2 commits December 30, 2025 12:40
Add class-level XML documentation for ICommand interface with summary
describing it as the core abstraction for executing command line tools
and processes, along with remarks pointing to IBash and IPowershell
for shell-specific execution.

Closes #1650

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add class-level XML documentation for AzureExtensions class with summary
describing extension methods for Azure integration and remarks about
using context.Azure() to access Azure CLI commands.

Also add method-level documentation for the public RegisterAzureContext
extension method describing its purpose of registering Azure services
with the dependency injection container.

Closes #1621

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@thomhurst
Copy link
Copy Markdown
Owner Author

Summary

Adds XML documentation comments to Azure extension methods and ICommand interface.

Critical Issues

None found ✅

Analysis

I've verified the documentation accuracy:

  1. AzureExtensions.cs (lines 21-31):

    • Class-level documentation correctly describes the extension methods
    • The context.Azure() usage example is accurate (verified in src/ModularPipelines.Examples/Modules/Azure/)
    • The extension method exists as Azure(this IPipelineHookContext) which works for IPipelineContext since it inherits from IPipelineHookContext
    • RegisterAzureContext method documentation accurately describes its purpose
  2. ICommand.cs (lines 6-9):

    • Interface-level documentation provides helpful context
    • Cross-references to IBash and IPowershell are valid (both interfaces exist)
    • Clarifies the relationship between the generic command interface and shell-specific ones

The documentation follows standard XML doc conventions and adds value for API consumers without changing any functionality.

Verdict

APPROVE - No critical issues

@thomhurst thomhurst merged commit 67a79bc into main Dec 30, 2025
10 of 12 checks passed
@thomhurst thomhurst deleted the fix/interface-docs branch December 30, 2025 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Code quality: ICommand interface missing class-level XML documentation Code quality: AzureExtensions missing class and method XML documentation

1 participant