Repository navigation
docs: add XML documentation to public types in Abstractions (#10) - #15
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds XML documentation to all public types and members in the
ImanSoftware.DepLens.Abstractionsproject, resolving allCS1591warnings ("Missing XML comment for publicly visible type or member").
This is the first documentation cleanup pass for the codebase. It focuses
only on
Abstractions, which had the largest concentration of warnings(~97 occurrences).
Changes
1. XML Documentation (
Abstractions)Added
/// <summary>comments to all public types:DependencyScope,DependencyType,FileType,PackageVersionSourceTypeDependency,ProjectDependencyReportDiscoveredFileIParsedContent,PackageDependency,ParsedFile,ParsedPackagesProps,ParsedProject,ParsedSolution,ProjectContext,ProjectReferenceLink,RawProjectReference,ResolvedProjectReferencesIService,IDepLensService,IDirectoryScanner,IParserService,IProjectOrienterService,IProjectReferenceLinkerService,IDependencyGraphBuilderService,IHtmlGraphReportServiceAdded
<param>tags to all public record constructors and method parameters,and
<returns>tags to interface methods.2. Analyzer Configuration (
.editorconfig)Suppressed two analyzer warnings that conflict with intentional design
choices:
CA1040("Avoid empty interfaces"):IParsedContentandIServiceare marker interfaces — a well-established pattern in C#. They
intentionally carry no members.
S2094("Remove this empty record"):ProjectReferenceLinkis anabstract base record used for a discriminated union pattern. The
derived records (
InternalProjectReference,ExternalProjectReference)define the actual shape.
3. Housekeeping
.gitignoreto exclude generated files (code-dump-result.md,tree-view-result.txt,dependency-graph.html).Validation
dotnet build -c Release:ImanSoftware.DepLens.AbstractionsImanSoftware.DepLens.CoreImanSoftware.DepLens.TestsTotal
Abstractionswarnings: 100 → 0.dotnet test: all tests pass.Scope Note
This PR intentionally focuses only on
Abstractions. RemainingCS1591warnings in
Core,Cli, andTestsare out of scope and will beaddressed in follow-up PRs.
Closes #10