AbstractDocImageType class

Abstract base class for image elements within documentation content.

Signature

export declare abstract class AbstractDocImageType extends AbstractDataModelBase

Extends: AbstractDataModelBase

Remarks

Represents image elements that can be embedded within documentation descriptions and content blocks. This implementation processes Doxygen's image elements, which support multiple output formats (HTML, LaTeX, DocBook, RTF, XML) and provide comprehensive image metadata including dimensions, captions, alternative text, and inline positioning.

Image elements support mixed content with text and formatting commands, allowing for rich image descriptions and captions. The class tracks HTML images specifically for asset copying during documentation generation.

Constructors

Constructor	Modifiers	Description
(constructor)(xml, element, elementName)		Constructs an AbstractDocImageType instance from XML element data.

Properties

Property	Modifiers	Type	Description
alt?		string | undefined	(Optional) Alternative text for accessibility and fallback purposes.
caption?		string | undefined	(Optional) Caption text for the image.
height?		string | undefined	(Optional) Height specification for the image.
inline?		boolean | undefined	(Optional) Inline positioning flag for the image.
name?		string | undefined	(Optional) Name or path of the image file.
type?		string | undefined	(Optional) Output format type for the image.
width?		string | undefined	(Optional) Width specification for the image.

---

Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.