#cp.docs

Documentation Tools.

These tools are for helping generate CommandPost documentation.

Example Usage:

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

#API Overview

Functions - API calls offered directly by the extension


Signature	`cp.docs.generate() -> none`
Type	Function
Description	Generates the CommandPost Developers Guide.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/docs/init.lua line 24


Signature	`cp.docs.generateExtensionLinks(folder) -> none`
Type	Function
Description	Returns markup of all of the API links for a specific group of extensions.
Parameters	folder - The folder you want to process (i.e. "cp", "plugins" or "hs").
Returns	The result as a string, otherwise `nil` if an error occurs.
Notes	None
Examples	None
Source	src/extensions/cp/docs/init.lua line 130


Signature	`cp.docs.updateDeveloperGuideSummary() -> boolean`
Type	Function
Description	Updates the Developer Guide Summary.
Parameters	None
Returns	`true` if successful otherwise `nil`
Notes	None
Examples	None
Source	src/extensions/cp/docs/init.lua line 53