Skip to content
@ng-doc/app / Interface

NgDocApiListDeclaration

A declaration of an API list, with the scope it belongs to.

DeclarationTypeScript
export interface NgDocApiListDeclaration { … }

Members

Properties

6
description?: string | undefined

A one-line description, when the API list data carries one.

kind: string

The kind of the declaration, for example Class or Function.

name: string

The name of the declaration.

route: string

The route of the declaration page, without the leading slash.

scope: string

The scope of the declaration, for example the package name.

signature?: string | undefined

The declaration header, when the API list data carries it.

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