@arcgis/api-extractor 5.0.0-next.135 → 5.0.0-next.137

package/dist/utils/jsDocParser.d.ts

@@ -1,46 +0,0 @@
-import { default as ts } from 'typescript';
-import { ApiCustomElementDeclaration, ApiCustomElementField } from '../apiJson.ts';
-import { NodeDoc } from '../types.ts';
-/**
- * Find node's JSDoc comment and parse it into a NodeDoc
- *
- * @param node AST node that has leading JSDoc comment
- * @param sourceFile Source file that contains the `node`
- * @param ensureIsPublic If true (default), will return undefined if JSDoc does
- * not contain a `@public` tag. In such cases, `@public` is not included in
- * `NodeDoc` as it is assumed.
- * @privateRemarks
- * FINAL: adopt in Lumina
- */
-export declare function getNodeDoc(node: ts.Node, sourceFile: ts.SourceFile, 
-/** @default true */
-ensureIsPublic?: boolean): NodeDoc | undefined;
-/**
- * TypeScript parses too much around \@param, \@property and \@deprecated tags
- * It also parses out inline tags. We have to put them back together
- * (overhead and complexity). Plus, it is a bit too tolerant - we want
- * to disallow some ambiguous behavior to improve consistency.
- * And TypeScript incorrectly parses decorators as tags when used inside code
- * snippets.
- *
- * Given all of the above, we implement a tiny, but strict JSDoc parser
- *
- * @param jsDocText JSDoc string that starts with /** and ends with *\/
- * @param sourceFile Used for error reporting
- * @param ensureIsPublic If true, will return undefined if JSDoc does not contain a \@public tag
- */
-declare function parseJsDoc(jsDocText: string, sourceFile: ts.SourceFile, ensureIsPublic?: false): NodeDoc;
-declare function parseJsDoc(jsDocText: string, sourceFile: ts.SourceFile, ensureIsPublic: boolean): NodeDoc | undefined;
-/**
- * @deprecated migrate to getNodeDoc
- */
-export declare function symbolToDocs(checker: ts.TypeChecker, symbol: ts.Signature | ts.Symbol): NodeDoc;
-/**
- * @deprecated migrate to getNodeDoc
- */
-export declare function setApiDocFromSymbol(node: ts.PropertyName, checker: ts.TypeChecker, api: Partial<Pick<ApiCustomElementDeclaration, "cssParts" | "cssProperties" | "cssStates" | "slots"> & Pick<ApiCustomElementField, "default" | "deprecated" | "description" | "docsTags" | "privacy" | "readonly">>): void;
-export declare function setApiDocFromJsDoc(api: Partial<Pick<ApiCustomElementDeclaration, "cssParts" | "cssProperties" | "cssStates" | "slots"> & Pick<ApiCustomElementField, "default" | "deprecated" | "description" | "docsTags" | "privacy" | "readonly">>, docs: ReturnType<typeof symbolToDocs>): void;
-export declare const exportsForTests: {
-    parseJsDoc: typeof parseJsDoc;
-};
-export {};

package/dist/utils/jsDocPrinter.d.ts

@@ -1,13 +0,0 @@
-import { default as ts } from 'typescript';
-import { ApiEvent, ApiCustomElementMember, ApiDeclaration, ApiModule, ApiClassMember } from '../apiJson.ts';
-import { NodeDoc } from '../types.ts';
-export declare function apiMemberToNodeDoc(apiMember: ApiClassMember | ApiCustomElementMember | ApiDeclaration | ApiEvent | ApiModule): NodeDoc | undefined;
-export declare function nodeDocToSynthesizedComment(nodeDoc: NodeDoc | undefined): ts.SynthesizedComment[];
-/**
- * Omitting leading /* and trailing *\/ as those will be inserted by TypeScript.
- *
- * @privateRemarks
- * This function is in the hot path - called for every API item. To reduce memory
- * churn, we avoid creating intermediate arrays inside.
- */
-export declare function nodeDocToString(nodeDoc: NodeDoc): string;

package/dist/utils/print.d.ts

@@ -1,6 +0,0 @@
-import { default as ts } from 'typescript';
-/**
- * For usage in error messages. Print original node text if available. Otherwise,
- * print the AST.
- */
-export declare function debugPrintNode(node: ts.Node, sourceFile: ts.SourceFile | undefined): string;