UNPKG

moxygen

Version:

Doxygen XML to Markdown converter

29 lines 1.54 kB
import type { Compound, Filters, Member, SectionGroup } from './types.js'; export declare function createCompound(parent?: Compound | null, id?: string, name?: string): Compound; export declare function findCompound(root: Compound, id: string, name: string, create: boolean): Compound | undefined; /** * Recursively collect compounds (and optionally filter by kind) into a flat array. */ export declare function toArray(compound: Compound, type?: 'compounds' | 'members', kind?: string): (Compound | Member)[]; /** * Recursively collect filtered compounds into a flat array. */ export declare function toFilteredArray(compound: Compound, type?: 'compounds' | 'members'): Compound[]; /** * Filter a collection by a key matching allowed categories, optionally scoped to a group. */ export declare function filterCollection(collection: Record<string, Compound | Member> | (Compound | Member)[], key: string, allowedCategories: string[], groupid?: string): (Compound | Member)[]; /** * Apply filters recursively to a compound and all its children. */ export declare function filterChildren(compound: Compound, filters: Filters, groupid?: string): void; /** * Remove noisy members: undocumented destructors, internal macros, * undocumented copy/move operators. */ export declare function filterNoise(members: Member[]): Member[]; /** * Group filtered members by their section kind for structured output. */ export declare function groupMembersBySection(compound: Compound): SectionGroup[]; //# sourceMappingURL=compound.d.ts.map