@gobstones/typedoc-theme-gobstones
Version:
A simple theme for the Gobstones generated documentation.
17 lines • 939 B
TypeScript
/**
* @module Theme/Partials
* @author Alan Rodas Bonjour <alanrodas@gmail.com>
*/
import { CommentDisplayPart, ContainerReflection, DeclarationReflection, DefaultThemeRenderContext, DocumentReflection, JSX, ProjectReflection, Reflection } from 'typedoc';
export interface MemberSections {
title: string;
description?: CommentDisplayPart[];
children: (DocumentReflection | DeclarationReflection)[];
}
/**
* Get the members of a container reflection.
*/
export declare const getMemberSections: (parent: ContainerReflection, childFilter?: (refl: Reflection) => boolean) => MemberSections[];
export declare const moduleReflection: (context: DefaultThemeRenderContext, mod: DeclarationReflection | ProjectReflection) => JSX.Element;
export declare const moduleMemberSummary: (context: DefaultThemeRenderContext, member: DeclarationReflection | DocumentReflection) => JSX.Element;
//# sourceMappingURL=moduleReflection.d.ts.map