Add code reference links and backticks to JSDoc comments#1484
Open
jonathanhefner wants to merge 2 commits intomodelcontextprotocol:mainfrom
Open
Add code reference links and backticks to JSDoc comments#1484jonathanhefner wants to merge 2 commits intomodelcontextprotocol:mainfrom
jonathanhefner wants to merge 2 commits intomodelcontextprotocol:mainfrom
Conversation
|
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
Replace plain text and backtick-quoted symbol references in JSDoc
comments with proper `{@linkcode}` tags for TypeDoc. This makes class
names, function names, and other symbols clickable in the generated API
documentation.
Also adds type-only imports with ESLint disable comments for symbols
that are only referenced in JSDoc `{@link}` tags.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Wrap code identifiers in backticks throughout JSDoc documentation for consistency. This includes parameter names, variable names, HTTP headers, OAuth grant types, URL paths, and string literals. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
jonathanhefner
force-pushed
the
jsdoc-links-and-backticks
branch
from
067ff0a to
3e75363
Compare
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
1 participant
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 PR contains 2 somewhat overlapping commits which add the following to JSDoc comments across the code base:
{@linkcode}tags to cross-link code references, both for ease of reference and to catch docs drift (viapnpm run docs:check)The diff is somewhat large, but essentially uniform. The additional lines (404 lines vs 414 lines) are due to extra import statements and
// eslint-disable-next-line @typescript-eslint/no-unused-varscomments to allow TypeDoc to reference previously-unimported types in some{@linkcode}tags (i.e., the imports are used by TypeDoc, but eslint doesn't recognize that).