UNPKG

typedoc

Version:

Create api documentation for TypeScript projects.

47 lines (46 loc) 2.47 kB
/** * @module TypeDoc API * * In addition to the members documented here, TypeDoc exports a `typedoc/debug` * entry point which exports some functions which may be useful during plugin * development or debugging. Exports from that entry point are **not stable** * and may change or be removed at any time. * * TypeDoc also exports a `typedoc/browser` entry point which exports a subset * of the members described here which makes it suitable for usage in browser * bundles which want to use TypeDoc's JSON output in the browser. */ export { Application } from "./lib/application.js"; export { resetReflectionID } from "./lib/models/Reflection.js"; /** * All symbols documented under the Models namespace are also available in the root import. * @primaryExport * * @categoryDescription Types * Describes a TypeScript type. * * @categoryDescription Reflections * Describes a documentation entry. The root entry is a {@link ProjectReflection} * and contains {@link DeclarationReflection} instances. * * @summary * TypeDoc converts source code into these object types. */ export * as Models from "./lib/models/index.js"; /** * All symbols documented under the Configuration namespace are also available in the root import. * @summary * Controls how TypeDoc reads option files and what options are available. */ export { Context, Converter, } from "./lib/converter/index.js"; export * from "./lib/models/index.js"; /** @primaryExport */ export * as Configuration from "./lib/utils/options/index.js"; export { BaseRouter, CategoryRouter, DefaultTheme, DefaultThemeRenderContext, GroupRouter, IndexEvent, KindDirRouter, KindRouter, MarkdownEvent, PageEvent, PageKind, Renderer, RendererEvent, Slugger, StructureDirRouter, StructureRouter, Theme, } from "./lib/output/index.js"; export { Outputs } from "./lib/output/output.js"; export { ArgumentsReader, CommentStyle, EntryPointStrategy, normalizePath, Option, OptionDefaults, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, ValidatingFileRegistry, } from "./lib/utils/index.js"; export { ConsoleLogger, EventDispatcher, EventHooks, i18n, JSX, Logger, LogLevel, MinimalSourceFile, translateTagName, } from "#utils"; export { Deserializer, JSONOutput, SerializeEvent, Serializer, } from "./lib/serialization/index.js"; export * as Internationalization from "./lib/internationalization/index.js"; import TypeScript from "typescript"; export { TypeScript };