docs

Last updated 4 months ago

Documentation Tools.

These tools are for helping generate CommandPost documentation.

Example Usage:

require("cp.docs").generate()

API Overview

API Documentation

Functions

generate

Signature

cp.docs.generate() -> none

Type

Function

Description

Generates the CommandPost Developers Guide.

Parameters

Returns

Signature

cp.docs.generateExtensionLinks(folder) -> none

Type

Function

Description

Returns markup of all of the API links for a specific group of extensions.

Parameters

Returns

Signature

cp.docs.updateDeveloperGuideSummary() -> boolean

Type

Function

Description

Updates the Developer Guide Summary.

Parameters

Returns