Skip to main content

AbstractCodeLineType class

Abstract base class for code line elements with syntax highlighting support.

Signature

export declare abstract class AbstractCodeLineType extends AbstractDataModelBase

Extends: AbstractDataModelBase

Remarks

Implements the XML Schema definition for codelineType elements, which represent individual lines of source code within program listings. Each code line may contain syntax highlighting information, line numbers, cross-references to documentation elements, and external link indicators.

All attributes are optional according to the schema, allowing for flexible representation of code content ranging from simple text lines to fully annotated source code with comprehensive metadata.

Constructors

Constructor

Modifiers

Description

(constructor)(xml, element, elementName)

Constructs an AbstractCodeLineType instance from XML element data.

Properties

Property

Modifiers

Type

Description

external?

boolean | undefined

(Optional) Optional flag indicating external reference status.

highlights?

HighlightDataModel[] | undefined

(Optional) Array of syntax highlighting elements within the code line.

lineno?

number | undefined

(Optional) Optional line number for the code line.

refid?

string | undefined

(Optional) Optional reference identifier for cross-linking.

refkind?

string | undefined

(Optional) Optional reference kind classification.


Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.