@ckeditor/typedoc-plugins
Version:
Various TypeDoc plugins developed by the CKEditor 5 team.
16 lines (15 loc) • 797 B
TypeScript
/**
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md.
*/
import { type Application } from "typedoc";
/**
* The `typedoc-plugin-purge-private-api-docs` removes reflections collected from private packages.
* It also removes reflections sources from augmented interfaces which are collected from private packages.
*
* Private packages are marked with the `private: true` property in their `package.json` files.
*
* We do not want to expose private APIs in the documentation, but the paid features may extend the configuration reflection.
* Add the `@publicApi` annotation to publish a private reflection within the block comment defining a module name.
*/
export declare function typeDocPurgePrivateApiDocs(app: Application): void;