Repository navigation
docs: Fix documentation links and add missing JSDoc comments - #1419
Merged
Merged
Conversation
In case-plugin-base: - Add missing @public release tags to the DSL declaration types, providePluginContext, MockExecutor and ContractCaseDslPlugin - Rewrite MatchContext#member links, which api-documenter rendered as empty text, to link to MatchContext with the method name in prose - Replace the cross-package LookupableMatcher link with plain code text, as api-documenter cannot resolve references outside the package In case-definition-dsl: - Correct @link namespace paths: mocks.* -> interactions.* and matchers.internals.* -> matchers.base.*, so api-documenter now emits working links instead of warnings - Suppress ae-unresolved-link, which false-positives on all links through the package's `import * as` namespaces (rushstack#1308); api-documenter still validates these links against the doc model Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JhUff3VLTEX3VSeyaFXTBi
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
This PR fixes broken documentation links and adds missing JSDoc comments to improve API documentation generation and clarity across the codebase.
Key Changes
Fixed namespace references in documentation: Updated incorrect
mocks.*namespace references tointeractions.*in JSDoc comments for function interaction classes (WillCallFunction, WillCallThrowingFunction, WillReceiveFunctionCall, WillReceiveHttpRequest)Fixed class reference links: Corrected JSDoc link from
matchers.internals.AnyMatcherWithExampletomatchers.base.AnyMatcherWithExamplein the AnyMatcher base classAdded missing JSDoc documentation: Added
@publicmarkers and descriptive comments to previously undocumented or partially documented types and functions:PluginDslDeclaration- describes DSL class declarationsParameterType- parameter type definitionsTypeContainer- complex type containersMatcherReference- matcher identificationPassToMatcher- composite matcher supportisPassToMatcher()- type guard functionisTypeContainer()- type guard functionParameterDeclaration- matcher parameter declarationsDslObjectDeclaration- object definitionsMatcherDslDeclaration- matcher DSL definitionsStateObjectDeclaration- state object definitionsInteractionDslDeclaration- interaction DSL definitionsImproved documentation clarity: Updated JSDoc comments to use inline code formatting and clearer references:
{@link MatchContext#descendAndCheck}to backtick-formatteddescendAndCheckon MatchContext{@link @contract-case/case-plugin-dsl-types#LookupableMatcher}to clearer inline referenceUpdated API extractor configuration: Added message suppression for
ae-unresolved-linkwarnings in case-definition-dsl to handle namespace re-export resolution limitationsUpdated version: Bumped case-definition-dsl package version from 0.31.1 to 0.31.2
Notable Implementation Details
@publicmarkers for exported types to ensure proper visibility in generated documentationhttps://claude.ai/code/session_01JhUff3VLTEX3VSeyaFXTBi