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) |
lsdoc extends the Programming Pages theme by providing two layouts for LoomScript documentation: package and type.
To use a layout, create a markdown or html file that has a yaml front-matter block at the top of the file, and provide values for the layout parameters within the front-matter block:
---
layout: "package"
module: "example"
classes:
- { declaration: "example/ExampleClass.ls", description: "Class description doc comments first line.\n\nAdditional class description documentation comments.\n\nCode sample:\n```as3\nvar c:ExampleClass = new ExampleClass();\n```", name: "ExampleClass" }
- { declaration: "example/ExampleSuperClass.ls", description: "SuperClass description doc comments first line.\n\nAdditional class description documentation comments.", name: "ExampleSuperClass" }
delegates:
- { declaration: "example/ExampleDelegate.ls", description: "Delegate method doc comments first line.\n\nThis method has one required parameter.", name: "ExampleDelegate" }
- { declaration: "example/ExampleDelegate.ls", description: "Another delegate's method doc comments first line.\n\nThis method has three required parameters and returns a `Boolean`.", name: "OtherExampleDelegate" }
enums:
- { declaration: "example/ExampleEnum.ls", description: "Enum doc comments first line.\n\nThis enumeration starts at zero and counts by ones,\nand has a `LAST` entry with value `999`.\n\nThe individual values can have their own doc comments.", name: "ExampleEnum" }
interfaces:
- { declaration: "example/ExampleInterface.ls", description: "Interface description doc comments first line.\n\nAdditional interface description documentation comments.", name: "ExampleInterface" }
structs:
- { declaration: "example/ExampleStruct.ls", description: "Struct description doc comments first line.\n\nAdditional struct description documentation comments.", name: "ExampleStruct" }
...
example.md
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) |