Skip to content

Commit

Permalink
Adopt @link for jsdoc comments (#1122)
Browse files Browse the repository at this point in the history
Fixes #1015
  • Loading branch information
mjbvz authored Nov 15, 2022
1 parent fdfdc03 commit edfd57c
Show file tree
Hide file tree
Showing 15 changed files with 222 additions and 222 deletions.
2 changes: 1 addition & 1 deletion jsonrpc/src/common/cancellation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export interface CancellationToken {
readonly isCancellationRequested: boolean;

/**
* An [event](#Event) which fires upon cancellation.
* An {@link Event event} which fires upon cancellation.
*/
readonly onCancellationRequested: Event<any>;
}
Expand Down
12 changes: 6 additions & 6 deletions protocol/src/common/protocol.colorProvider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface DocumentColorRegistrationOptions extends TextDocumentRegistrati
//---- Color Symbol Provider ---------------------------

/**
* Parameters for a [DocumentColorRequest](#DocumentColorRequest).
* Parameters for a {@link DocumentColorRequest}.
*/
export interface DocumentColorParams extends WorkDoneProgressParams, PartialResultParams {
/**
Expand All @@ -42,8 +42,8 @@ export interface DocumentColorParams extends WorkDoneProgressParams, PartialResu

/**
* A request to list all color symbols found in a given text document. The request's
* parameter is of type [DocumentColorParams](#DocumentColorParams) the
* response is of type [ColorInformation[]](#ColorInformation) or a Thenable
* parameter is of type {@link DocumentColorParams} the
* response is of type {@link ColorInformation ColorInformation[]} or a Thenable
* that resolves to such.
*/
export namespace DocumentColorRequest {
Expand All @@ -54,7 +54,7 @@ export namespace DocumentColorRequest {
}

/**
* Parameters for a [ColorPresentationRequest](#ColorPresentationRequest).
* Parameters for a {@link ColorPresentationRequest}.
*/
export interface ColorPresentationParams extends WorkDoneProgressParams, PartialResultParams {
/**
Expand All @@ -75,8 +75,8 @@ export interface ColorPresentationParams extends WorkDoneProgressParams, Partial

/**
* A request to list all presentation for a color. The request's
* parameter is of type [ColorPresentationParams](#ColorPresentationParams) the
* response is of type [ColorInformation[]](#ColorInformation) or a Thenable
* parameter is of type {@link ColorPresentationParams} the
* response is of type {@link ColorInformation ColorInformation[]} or a Thenable
* that resolves to such.
*/
export namespace ColorPresentationRequest {
Expand Down
4 changes: 2 additions & 2 deletions protocol/src/common/protocol.declaration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ export interface DeclarationParams extends TextDocumentPositionParams, WorkDoneP
/**
* A request to resolve the type definition locations of a symbol at a given text
* document position. The request's parameter is of type [TextDocumentPositionParams]
* (#TextDocumentPositionParams) the response is of type [Declaration](#Declaration)
* or a typed array of [DeclarationLink](#DeclarationLink) or a Thenable that resolves
* (#TextDocumentPositionParams) the response is of type {@link Declaration}
* or a typed array of {@link DeclarationLink} or a Thenable that resolves
* to such.
*/
export namespace DeclarationRequest {
Expand Down
6 changes: 3 additions & 3 deletions protocol/src/common/protocol.foldingRange.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export interface FoldingRangeRegistrationOptions extends TextDocumentRegistratio
}

/**
* Parameters for a [FoldingRangeRequest](#FoldingRangeRequest).
* Parameters for a {@link FoldingRangeRequest}.
*/
export interface FoldingRangeParams extends WorkDoneProgressParams, PartialResultParams {
/**
Expand All @@ -86,8 +86,8 @@ export interface FoldingRangeParams extends WorkDoneProgressParams, PartialResul

/**
* A request to provide folding ranges in a document. The request's
* parameter is of type [FoldingRangeParams](#FoldingRangeParams), the
* response is of type [FoldingRangeList](#FoldingRangeList) or a Thenable
* parameter is of type {@link FoldingRangeParams}, the
* response is of type {@link FoldingRangeList} or a Thenable
* that resolves to such.
*/
export namespace FoldingRangeRequest {
Expand Down
2 changes: 1 addition & 1 deletion protocol/src/common/protocol.implementation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface ImplementationParams extends TextDocumentPositionParams, WorkDo
/**
* A request to resolve the implementation locations of a symbol at a given text
* document position. The request's parameter is of type [TextDocumentPositionParams]
* (#TextDocumentPositionParams) the response is of type [Definition](#Definition) or a
* (#TextDocumentPositionParams) the response is of type {@link Definition} or a
* Thenable that resolves to such.
*/
export namespace ImplementationRequest {
Expand Down
8 changes: 4 additions & 4 deletions protocol/src/common/protocol.inlayHint.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ export type InlayHintParams = WorkDoneProgressParams & {

/**
* A request to provide inlay hints in a document. The request's parameter is of
* type [InlayHintsParams](#InlayHintsParams), the response is of type
* [InlayHint[]](#InlayHint[]) or a Thenable that resolves to such.
* type {@link InlayHintsParams}, the response is of type
* {@link InlayHint InlayHint[]} or a Thenable that resolves to such.
*
* @since 3.17.0
*/
Expand All @@ -106,8 +106,8 @@ export namespace InlayHintRequest {

/**
* A request to resolve additional properties for an inlay hint.
* The request's parameter is of type [InlayHint](#InlayHint), the response is
* of type [InlayHint](#InlayHint) or a Thenable that resolves to such.
* The request's parameter is of type {@link InlayHint}, the response is
* of type {@link InlayHint} or a Thenable that resolves to such.
*
* @since 3.17.0
*/
Expand Down
4 changes: 2 additions & 2 deletions protocol/src/common/protocol.inlineValue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export type InlineValueParams = WorkDoneProgressParams & {

/**
* A request to provide inline values in a document. The request's parameter is of
* type [InlineValueParams](#InlineValueParams), the response is of type
* [InlineValue[]](#InlineValue[]) or a Thenable that resolves to such.
* type {@link InlineValueParams}, the response is of type
* {@link InlineValue InlineValue[]} or a Thenable that resolves to such.
*
* @since 3.17.0
*/
Expand Down
4 changes: 2 additions & 2 deletions protocol/src/common/protocol.moniker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ export interface MonikerParams extends TextDocumentPositionParams, WorkDoneProgr

/**
* A request to get the moniker of a symbol at a given text document position.
* The request parameter is of type [TextDocumentPositionParams](#TextDocumentPositionParams).
* The response is of type [Moniker[]](#Moniker[]) or `null`.
* The request parameter is of type {@link TextDocumentPositionParams}.
* The response is of type {@link Moniker Moniker[]} or `null`.
*/
export namespace MonikerRequest {
export const method: 'textDocument/moniker' = 'textDocument/moniker';
Expand Down
4 changes: 2 additions & 2 deletions protocol/src/common/protocol.selectionRange.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ export interface SelectionRangeParams extends WorkDoneProgressParams, PartialRes

/**
* A request to provide selection ranges in a document. The request's
* parameter is of type [SelectionRangeParams](#SelectionRangeParams), the
* response is of type [SelectionRange[]](#SelectionRange[]) or a Thenable
* parameter is of type {@link SelectionRangeParams}, the
* response is of type {@link SelectionRange SelectionRange[]} or a Thenable
* that resolves to such.
*/
export namespace SelectionRangeRequest {
Expand Down
Loading

0 comments on commit edfd57c

Please sign in to comment.