Skip to content

Parse new DeclarationReference format in TSDoc #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Parse new DeclarationReference format in TSDoc #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a92bd9
Add additional utility methods to DeclarationReference
rbuckton May 1, 2022
cd81fc9
Allow parsing of 'beta' DeclarationReference when parsing a DocDeclar…
rbuckton May 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions common/changes/@microsoft/tsdoc/beta-declref-utility_2022-05-16-07-02.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "@microsoft/tsdoc",
"comment": "add utility methods to DeclarationReference components",
"type": "minor"
}
],
"packageName": "@microsoft/tsdoc",
"email": "ron.buckton@microsoft.com"
}
11 changes: 11 additions & 0 deletions common/changes/@microsoft/tsdoc/parse-beta-declref_2022-05-16-07-04.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "@microsoft/tsdoc",
"comment": "parse beta DeclarationReference in TSDoc",
"type": "minor"
}
],
"packageName": "@microsoft/tsdoc",
"email": "ron.buckton@microsoft.com"
}
29 changes: 27 additions & 2 deletions tsdoc/etc/tsdoc.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,11 @@ export class DocComment extends DocNode {
// @public
export class DocDeclarationReference extends DocNode {
// @internal
constructor(parameters: IDocDeclarationReferenceParameters | IDocDeclarationReferenceParsedParameters);
constructor(parameters: IDocDeclarationReferenceParameters | IDocDeclarationReferenceParsedParameters | IBetaDocDeclarationReferenceParameters | IBetaDocDeclarationReferenceParsedParameters);
// Warning: (ae-forgotten-export) The symbol "DeclarationReference" needs to be exported by the entry point index.d.ts
//
// @beta
get declarationReference(): DeclarationReference | undefined;
emitAsTsdoc(): string;
get importPath(): string | undefined;
// @override (undocumented)
Expand Down Expand Up @@ -450,6 +454,8 @@ export enum ExcerptKind {
// (undocumented)
CodeSpan_OpeningDelimiter = "CodeSpan_OpeningDelimiter",
// (undocumented)
DeclarationReference_DeclarationReference = "DeclarationReference_DeclarationReference",
// (undocumented)
DeclarationReference_ImportHash = "DeclarationReference_ImportHash",
// (undocumented)
DeclarationReference_ImportPath = "DeclarationReference_ImportPath",
Expand Down Expand Up @@ -531,6 +537,20 @@ export enum ExcerptKind {
Spacing = "Spacing"
}

// @beta
export interface IBetaDocDeclarationReferenceParameters extends IDocNodeParameters {
// (undocumented)
declarationReference: DeclarationReference;
}

// @beta
export interface IBetaDocDeclarationReferenceParsedParameters extends IDocNodeParsedParameters {
// (undocumented)
declarationReference?: DeclarationReference;
// (undocumented)
declarationReferenceExcerpt: TokenSequence;
}

// @public
export interface IDocBlockParameters extends IDocNodeParameters {
// (undocumented)
Expand Down Expand Up @@ -1085,8 +1105,10 @@ export class ParserMessageLog {
addMessageForDocErrorText(docErrorText: DocErrorText): void;
addMessageForTextRange(messageId: TSDocMessageId, messageText: string, textRange: TextRange): void;
addMessageForTokenSequence(messageId: TSDocMessageId, messageText: string, tokenSequence: TokenSequence, docNode?: DocNode): void;
createMarker(): number;
get messages(): ReadonlyArray<ParserMessage>;
}
rollbackToMarker(marker: number): void;
}

// @public
export class PlainTextEmitter {
Expand Down Expand Up @@ -1248,6 +1270,9 @@ export class TSDocConfiguration {
isHtmlElementSupported(htmlTag: string): boolean;
isKnownMessageId(messageId: TSDocMessageId | string): boolean;
isTagSupported(tagDefinition: TSDocTagDefinition): boolean;
// (undocumented)
get parseBetaDeclarationReferences(): boolean | 'prefer';
set parseBetaDeclarationReferences(value: boolean | 'prefer');
setSupportedHtmlElements(htmlTags: string[]): void;
setSupportForTag(tagDefinition: TSDocTagDefinition, supported: boolean): void;
setSupportForTags(tagDefinitions: ReadonlyArray<TSDocTagDefinition>, supported: boolean): void;
Expand Down
Loading