Conversation
Refactored DetermineNameQualifier to clarify qualification rules for types, operators, extension methods, and members in the current type scope. Added comprehensive unit tests to cover all logic branches.
…tensibility Refactored DocumentationContext to initialize UrlTransformer via a new protected virtual CreateUrlTransformer() method. This allows derived classes to override and provide custom URL transformer implementations.
Introduce UrlReference to encapsulate documentation URL metadata, and UrlReferenceCollector to record all URLs processed by an IUrlTransformer. Add comprehensive unit tests for collector behavior, including constructor validation and URL recording logic.
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.
This pull request introduces new infrastructure for tracking and validating external links in documentation, refines name qualification logic for documentation members, and adds comprehensive tests for these behaviors. It also includes a minor project version bump and configuration tweaks.
URL Tracking and Validation Infrastructure:
UrlReferenceclass to represent and encapsulate non-API URLs referenced in documentation, including their context and resolution status. (src/Routing/UrlReference.cs)UrlReferenceCollectorclass that decorates anIUrlTransformerto record all processed URLs, enabling validation and analysis of documentation links. (src/Routing/UrlReferenceCollector.cs)CreateUrlTransformermethod, making it easier to inject link validation or tracking logic. (src/DocumentationContext.cs) [1] [2]kampose.jsonto disable external link verification by default (setverifyExternalLinksto false), and broadened the assembly search path for documentation. (kampose.json)Name Qualification Logic Improvements:
DetermineNameQualifierto clarify when member names require qualification, including improved handling for extension methods, operators, and members in the current type scope. (src/DocumentationContextExtensions.cs)tests/DocumentationContextExtensionsTests.cs)Other Changes:
src/Kampute.DocToolkit.csproj)NUnit3TestAdapterversion 6.0.1. (tests/Kampute.DocToolkit.Test.csproj)tests/DocumentationContextExtensionsTests.cs)