@gobstones/typedoc-theme-gobstones/dist/Theme/GobstonesTheme.d.ts

A simple theme for the Gobstones generated documentation.

import { DeclarationReflection, DefaultTheme, DefaultThemeRenderContext, DocumentReflection, PageEvent, Reflection, Renderer } from 'typedoc';
/**
 * This class represents the main element of the theme.
 * An instance of this class is automatically created by
 * TypeDoc when the theme is going to be used, and it's
 * constructor method called upon theme initialization.
 *
 * @remarks
 * A Theme can be defined as a subclass of the built-in TypeDoc's
 * `Theme` class. Yet, it is most useful to re-use basic behavior by
 * extending the `DefaultTheme` class instead.
 * By extending this class, we should only overwrite methods that are
 * going to change from the default class, most likely the {@link constructor}
 * method and the {@link getRenderContext} methods. By doing this we can also
 * have the benefit of accessing the currently running application through the
 * `this.application` property, allowing us to access different hooks.
 */
export declare class GobstonesTheme extends DefaultTheme {
    /**
     * The initialize method is called upon theme setup by TypeDoc.
     * This method's main purpose is to provide basic theme setup,
     * either at startup or at specific moments by using the application
     * hooks.
     */
    constructor(renderer: Renderer);
    /**
     * Returns the render context for this theme.
     *
     * @param pageEvent - A page event with a reflection.
     *
     * @returns The associated render context for this theme.
     */
    getRenderContext(pageEvent: PageEvent<Reflection>): DefaultThemeRenderContext;
    /**
     * Get the reflection classes of this theme.
     *
     * @remarks
     * Reflection classes are used at the theme's representation when
     * presented into the interface. This being here doesn't seem to make
     * much sense, as it has to do with the rendering and not with the
     * theme itself. Yet, this is how it's defined in the original theme,
     * thus, we need to overwrite it here.
     *
     * @param reflection - The reflection to get the classes from.
     *
     * @returns A string that represents all reflection classes.
     */
    getReflectionClasses(reflection: DeclarationReflection | DocumentReflection): string;
}
//# sourceMappingURL=GobstonesTheme.d.ts.map