Docio

Slots

DocsParser

DocsParser

PageGenerator

PageGenerator

categories

DocsParser docsMap sorted by categories.

copyTemplate(templateDir)

extractDocs

Generates docs.txt using DocsExtractor.

generateDocs

Generates documentation for the package at packagePath.

generateSite

Use this only after you did parsing.

getDocsTxt

openDocsForPackageWithName(packageName)

outputPath

Path to the docs in the destination package's directory.

packageInfo

Returns package.json as an instance of Map.

packageName

packagePath

printDocFor(query)

Prints documentation for the given query.

The method will try to extract the documentation from the doc comments, if the docs/docs.txt doesn't exist in the package's directory.

Examples of query: "ProtoName" "ProtoName slotName" "AddonName ProtoName slotName"

templatePath