jasy.script.api package

Submodules

jasy.script.api.Comment module

class jasy.script.api.Comment.Comment(text, context=None, lineNo=0, indent='', fileId=None)

Bases: builtins.object

Comment class is attached to parsed nodes and used to store all comment related information.

The class supports a new Markdown and TomDoc inspired dialect to make developers life easier and work less repeative.

context = None

getHtml(highlight=True)

Returns the comment text converted to HTML

Parameters:highlight (bool) – Whether to highlight the code

getTags()

hasContent()

hasTag(name)

params = None

returns = None

tags = None

text = None

type = None

exception jasy.script.api.Comment.CommentException(message, lineNo=0)

Bases: builtins.Exception

Thrown when errors during comment processing are detected.

jasy.script.api.Data module

class jasy.script.api.Data.ApiData(id, highlight=True)

Bases: builtins.object

Container for all relevant API data. Automatically generated, filled and cached by jasy.item.Script.getApiDocs().

addAssets(assets)

Adds the info about used assets

addConstructor(valueNode, commentNode=None)

addEntry(name, valueNode, commentNode, collection)

addEvent(name, valueNode, commentNode, collection)

addFields(permutations)

addProperty(name, valueNode, commentNode, collection)

addSize(size)

Adds the statistics on different size aspects

addUses(uses)

assets

basename

construct

content

errors

events

export()

highlight

id

implementedBy

implements

includedBy

includes

isEmpty

main

members

package

permutations

properties

removeUses(uses)

scanTree(tree)

setMain(mainType, mainNode, exportName)

size

statics

usedBy

uses

warn(message, line)

jasy.script.api.Text module

jasy.script.api.Text.extractSummary(text)

jasy.script.api.Writer module

class jasy.script.api.Writer.ApiWriter(profile)

Bases: builtins.object

Processes JavaScript classes into data for API documentation. Exports plain data which can be used by a wide varity of tools for further processing or for displaying documentation. A good example of how to use the data generated by write is the ApiBrowser: https://github.com/zynga/apibrowser

write(distFolder, classFilter=None, callback='apiload', showInternals=False, showPrivates=False, printErrors=True, highlightCode=True)

Writes API data generated from JavaScript into distFolder

Parameters:

• distFolder (str) – Where to store the API data
• classFilter (tuple or function) – Tuple of classes or method to use for filtering
• callback (function) – Name of callback to use for loading or None if pure JSON should be used
• showInternals (bool) – Include internal methods inside API data
• showPrivates (bool) – Include private methods inside API data
• printErrors (bool) – Whether errors should be printed to the console
• highlightCode (bool) – Whether to enable code highlighting using Pygments

jasy.script.api.Writer.connectInterface(className, interfaceName, classApi, interfaceApi)

jasy.script.api.Writer.convertFunction(item)

jasy.script.api.Writer.convertTags(item)

jasy.script.api.Writer.isErrornous(data)

jasy.script.api.Writer.mergeMixin(className, mixinName, classApi, mixinApi)

jasy.script.api.Writer.safeUpdate(dest, origin)

Like update() but only never overwrites

Module contents