#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


#API Documentation

#Functions

Signaturecp.docs.generate() -> none
TypeFunction
DescriptionGenerates the CommandPost Developers Guide.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/docs/init.lua line 24

Signaturecp.docs.generateExtensionLinks(folder) -> none
TypeFunction
DescriptionReturns 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.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/docs/init.lua line 130

Signaturecp.docs.updateDeveloperGuideSummary() -> boolean
TypeFunction
DescriptionUpdates the Developer Guide Summary.
Parameters
  • None
Returns
  • true if successful otherwise nil
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/docs/init.lua line 53