Renders API documentation for a type construct, including the following sections:
The interface list provides links to all the interface summary pages implemented by the described type.
The ancestor chain provides links to all the parent types in the type hierarchy, up to the base type.
The inheritance tree provides links to all direct sub-types of the described type.
For every provided field, property, or method, the declaration signature is rendered, showing links to parameter and value types.
All documentation sections occur in two levels of detail: both a short synopsis and a filter detail section. The synopsis links to the detail further down the page.
Some page variables use a method info value, which is an object with the following keys:
method_info:
attributes: [ string ]
description: string
name: string
parameters: [ { default_value: string, name: string, type: string } ]
type: string
Some page variables use a field info value, which is an object with the following keys:
field_info:
attributes: [ string ]
description: string
name: string
type: string
---
layout: "type"
ancestors: [ { module: string, name: string }, ..]
constructor: method_info
description: string
fields: [ field_info, .. ]
methods: [ method_info, ..]
module: string
name: string
properties: [ field_info, .. ]
tags: [ { name: string, value: string }, ..]
type: string
type_attributes: [ string, .. ]
---
<content>
ancestors | optional chain of ancestors this type inherits from, ordered with parent first, then grandparent, great grandparent, and so on.
|
constructor | optional signature of the type constructor method (if it has one)
|
description | documentation comments for the type; markdown is supported |
fields | optional list of public and protected fields the type has
|
methods | optional list of public and protected method signatures the type implements
|
module | package the type is a member of |
name | name of the type |
properties | optional list of public and protected properties the type has
|
tags | optional documentation tags assigned to the type
|
type | construct of the type (e.g. CLASS , INTERFACE , STRUCT )
|
type_attributes | list of access modifiers for the type (e.g. public , final , native )
|
lsdoc
2018 pixeldroid
https://github.com/pixeldroid/lsdoc |
programming pages theme v0.5.10 (https://github.com/pixeldroid/programming-pages) |
s |
focus search bar ( enter to select, ▲ / ▼ to change selection) |
g a |
go to api |
g e |
go to examples |
g g |
go to guides |
h |
toggle this help ( esc also exits) |