@gobstones/typedoc-theme-gobstones
Version:
A simple theme for the Gobstones generated documentation.
30 lines • 1.1 kB
TypeScript
import { TypedocPlugin } from '../Utils/Plugins';
/**
* A Plugin class that re-defines the `typedoc-plugin-not-exported` plugin.
*
* @remarks
* As it was defined, the `typedoc-plugin-not-exported` plugin is not quite
* useful to our theme. By making small modifications, the plugin now uses
* the `internal` flag to also include elements as exported.
*
* Note that there are some limitations on the behavior of the plugin. The
* `internal` modifier should only be used with modules, or members of a module,
* but not classes or interfaces.
*/
export declare class NotExportedPlugin extends TypedocPlugin {
/**
* The reflections already checked for module exports
*/
private checkedForModuleExports;
/**
* The tags to include into the documentation. Note that by default
* _internal_ is used, thus, requiring the includeInternal option to
* be set to true.
*/
private _includedTags;
/** @inheritdoc */
initialize(): void;
private _lookForFakeExports;
private _checkFakeExportsOfFile;
}
//# sourceMappingURL=NotExportedPlugin.d.ts.map