60 行
2.6 KiB
JavaScript
60 行
2.6 KiB
JavaScript
|
"use strict";
|
||
|
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
||
|
|
// See LICENSE in the project root for license information.
|
||
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||
|
|
exports.ApiItemMetadata = void 0;
|
||
|
|
const VisitorState_1 = require("./VisitorState");
|
||
|
|
/**
|
||
|
|
* Stores the Collector's additional analysis for an `AstDeclaration`. This object is assigned to
|
||
|
|
* `AstDeclaration.apiItemMetadata` but consumers must always obtain it by calling `Collector.fetchApiItemMetadata()`.
|
||
|
|
*
|
||
|
|
* @remarks
|
||
|
|
* Note that ancillary declarations share their `ApiItemMetadata` with the main declaration,
|
||
|
|
* whereas a separate `DeclarationMetadata` object is created for each declaration.
|
||
|
|
*
|
||
|
|
* Consider this example:
|
||
|
|
* ```ts
|
||
|
|
* export declare class A {
|
||
|
|
* get b(): string;
|
||
|
|
* set b(value: string);
|
||
|
|
* }
|
||
|
|
* export declare namespace A { }
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* In this example, there are two "symbols": `A` and `b`
|
||
|
|
*
|
||
|
|
* There are four "declarations": `A` class, `A` namespace, `b` getter, `b` setter
|
||
|
|
*
|
||
|
|
* There are three "API items": `A` class, `A` namespace, `b` property. The property getter is the main declaration
|
||
|
|
* for `b`, and the setter is the "ancillary" declaration.
|
||
|
|
*/
|
||
|
|
class ApiItemMetadata {
|
||
|
|
constructor(options) {
|
||
|
|
/**
|
||
|
|
* Tracks whether or not the associated API item is known to be missing sufficient documentation.
|
||
|
|
*
|
||
|
|
* @remarks
|
||
|
|
*
|
||
|
|
* An "undocumented" item is one whose TSDoc comment which either does not contain a summary comment block, or
|
||
|
|
* has an `@inheritDoc` tag that resolves to another "undocumented" API member.
|
||
|
|
*
|
||
|
|
* If there is any ambiguity (e.g. if an `@inheritDoc` comment points to an external API member, whose documentation,
|
||
|
|
* we can't parse), "undocumented" will be `false`.
|
||
|
|
*
|
||
|
|
* @remarks Assigned by {@link DocCommentEnhancer}.
|
||
|
|
*/
|
||
|
|
this.undocumented = true;
|
||
|
|
this.docCommentEnhancerVisitorState = VisitorState_1.VisitorState.Unvisited;
|
||
|
|
const { declaredReleaseTag, effectiveReleaseTag, releaseTagSameAsParent, isEventProperty, isOverride, isSealed, isVirtual, isPreapproved } = options;
|
||
|
|
this.declaredReleaseTag = declaredReleaseTag;
|
||
|
|
this.effectiveReleaseTag = effectiveReleaseTag;
|
||
|
|
this.releaseTagSameAsParent = releaseTagSameAsParent;
|
||
|
|
this.isEventProperty = isEventProperty;
|
||
|
|
this.isOverride = isOverride;
|
||
|
|
this.isSealed = isSealed;
|
||
|
|
this.isVirtual = isVirtual;
|
||
|
|
this.isPreapproved = isPreapproved;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
exports.ApiItemMetadata = ApiItemMetadata;
|
||
|
|
//# sourceMappingURL=ApiItemMetadata.js.map
|
