Renders a summary page for a code package. Groups package members by type and notes the declaring file, if provided.
A package (or module), is a collection of files that belong to the same namespace.
This template supports the LoomScript language constructs (enum, struct, class, etc.), and auto-links to the corresponding type summary page. If a type summary page cannot be located, no link will be generated.
Construct meta data should be provided in the following format:
[ { declaration: string, description: string, name: string } ]
---
layout: "package"
classes: [ { declaration: string, description: string, name: string }, .. ]
delegates: [ { declaration: string, description: string, name: string }, .. ]
enums: [ { declaration: string, description: string, name: string }, .. ]
interfaces: [ { declaration: string, description: string, name: string }, .. ]
module: string
structs: [ { declaration: string, description: string, name: string }, .. ]
submodules: [ string, .. ]
---
<content>
classes | optional list of classes that belong to the package
|
delegates | optional list of delegates that belong to the package
|
enums | optional list of enums that belong to the package
|
interfaces | optional list of interfaces that belong to the package
|
module | name of the package |
structs | optional list of structs that belong to the package
|
submodules | optional list of child packages
|
|
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) |