Skip to content
@ng-doc/core / Interface

NgDocGlobalKeyword

Global keyword configuration.

DeclarationTypeScript
export interface NgDocGlobalKeyword { … }

Members

Properties

4
description?: string | undefined

Description that will be displayed in a tooltip on hover.

title?: string | undefined

Keyword title that will be displayed in the link. If not provided, the keyword will be displayed as is.

type?: "link" | undefined

Determines how the keyword should be displayed. (rendered as a link in inline code by default)

url: string

Url that will be used to generate the link.

Symbol
Kind
Interface
Scope
@ng-doc/core
Edit this page