Docio
Slots
DocsParser
PageGenerator
categories
DocsParser docsMapsorted by categories.copyTemplate(templateDir)
extractDocs
Generates
docs.txtusing DocsExtractor.generateDocs
Generates documentation for the package at
packagePath.generateSite
Use this only after you did parsing.
getDocsTxt
openDocsForPackageWithName(packageName)
outputPath
Path to the
docsin 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
doccomments, if thedocs/docs.txtdoesn't exist in the package's directory.Examples of query:
"ProtoName" "ProtoName slotName" "AddonName ProtoName slotName"templatePath