@private

Tag Kind

Modifier

TSDoc Reference

TypeDoc specific

This tag should generally not be used and may be removed in a future release. The @private tag overrides the visibility of a reflection to be private.

Example

export class Visibility {
    /** @private */
    member = 123;
}

// Will be documented as:
export class Visibility {
    private member = 123;
}

See Also

• The @public tag
• The @protected tag
• The @internal tag
• The --excludePrivate option