loadimpact-lua-api-doc v0.0.4

loadimpact-api-doc

{
  "modules": [{ModuleType}],
  "LuaModules": [{LuaModuleType}]
}

ModuleType:

• id
• title
• description
• apis: ARRAYApiType
• classes: ARRAY
  • id
  • name
  • longName
  • description
  • apis: ARRAYApiType
  • attributes: ARRAYParameterType
  • examples: ARRAYExampleType
• enums: ARRAY {id, longName, description}
• examples: ARRAYExampleType
• notes: ARRAY string

LuaModuleType:

• id
• name
• description
• modules: ARRAY
  • id
  • name
  • moduleName
  • apis: ARRAY {name, link}

ApiType:

• id
• name
• longName
• description
• parameters: ARRAYParameterType
• returns: string
• options: ARRAY[{name, parameters = ARRAYParameterType}]
• examples: ARRAYExampleType

ExampleType:

• id (optional)
• title (optional)
• content: ARRAYstring

ParameterType:

• name
• type
• description