Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/core / Interface

NgDocApi

No documentation has been provided.

Properties

NameTypeDescription
category
NgDocCategory | undefined

The page category

hidden
inherited from NgDocBaseEntity
boolean | undefined

If true the page will be hidden from the sidebar

keyword
string | undefined

Custom keyword that uses to create links to this page

order
inherited from NgDocBaseEntity
number | undefined

Order is using for sorting entities in the sidebar

route
overrides NgDocBaseEntity
string | undefined

The route of the entity (current sourceFileFolder name by default)

scopes
NgDocApiScope[]

The API scopes, you can use it to define scopes for files that should be included to the API

title
inherited from NgDocBaseEntity
string

The entity title