Interface FileDocumentationPartValue

Add a value documentation.

Hierarchy-Diagram

UML class diagram of FileDocumentationPartValue
Legend
icon for an interface in the UML class diagram interface
icon for a public property in the UML class diagram public property

Hierarchy

Properties

description? isComment? title? type value?

Properties

Optional description

description?: FileDocumentationPartValueDescription

Optional value description.

Optional isComment

isComment?: boolean

Indicates if its a value (default) or a comment which means a comment character will be in front of the value.

Optional title

title?: OrArray<string>

Optional value title.

type

type: VALUE

Optional value

value?: string

Optional value to document.

Settings

Member Visibility

Theme

Generated using TypeDoc