Skip to main content

BriefDescriptionDataModel class

Data model for brief description elements within documentation.

Signature

export declare class BriefDescriptionDataModel extends AbstractDescriptionType

Extends: AbstractDescriptionType

Remarks

Represents brief description elements that provide concise summary content for entities. This implementation processes Doxygen's briefdescription elements, which contain short descriptive content used for entity summaries, overviews, and quick reference information within documentation structures.

Brief descriptions are typically displayed in listings, summaries, and overview sections to provide immediate context about documented entities without requiring full detailed descriptions.

Constructors

Constructor

Modifiers

Description

(constructor)(xml, element)

Constructs a BriefDescriptionDataModel from XML element data.


Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.