Skip to content

docs: Add XML documentation to BuildingBlocks APIs#1201

Merged
iammukeshm merged 8 commits intodevelopfrom
docs/api-documentation
Jan 31, 2026
Merged

docs: Add XML documentation to BuildingBlocks APIs#1201
iammukeshm merged 8 commits intodevelopfrom
docs/api-documentation

Conversation

@iammukeshm
Copy link
Member

Summary

Add XML documentation comments to public APIs in BuildingBlocks for better IntelliSense and auto-generated docs.

Progress

  • Caching - ICacheService, HybridCacheService, DistributedCacheService, Extensions
  • Core/Domain - IEntity, AggregateRoot, DomainEvent, etc.
  • Persistence - Specifications, DbContext extensions
  • Shared/Identity - Authorization, Permissions
  • Multitenancy - Tenant services

Closes #1176

jarvis added 2 commits January 31, 2026 01:58
- ICacheService: Document all interface methods
- CacheServiceExtensions: Document GetOrSet patterns
- Extensions: Document AddHeroCaching DI registration
- DistributedCacheService: Document implementation details
- HybridCacheService: Document L1/L2 caching strategy

Part of #1176
- IEntity, BaseEntity, AggregateRoot: Entity and DDD base types
- IDomainEvent, DomainEvent, IHasDomainEvents: Domain event patterns
- IAuditableEntity: Audit metadata interface
- ISoftDeletable: Soft delete support
- IHasTenant: Multi-tenancy marker

Generated by Codex CLI with --full-auto flag

Part of #1176
@iammukeshm iammukeshm marked this pull request as ready for review January 31, 2026 02:03
@iammukeshm iammukeshm merged commit 464a4d9 into develop Jan 31, 2026
8 checks passed
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.

[Documentation] Add XML docs to BuildingBlocks public APIs

1 participant