Provides run-time support for generating and including documentation for installed Hammerspoon Spoon bundles.
This module provides support for building (if necessary) and loading the documentation for installed Spoon bundles. In general, it is not expected that most users will have a need to access these functions directly.
Signature | hs.doc.spoonsupport.findSpoons() -> pathTable, spoonsTable |
---|---|
Type | Function |
Description | Returns tables describing where spoons are installed and what spoons are currently available. Parameters:
Returns:
|
Signature | hs.doc.spoonsupport.makeDocsFile(spoonPath, [force]) -> none |
---|---|
Type | Function |
Description | Create the docs.json file for the Spoon bundle at the specified path. Parameters:
Returns:
|
Signature | hs.doc.spoonsupport.updateDocFiles() -> none |
---|---|
Type | Function |
Description | Creates and updates the included documentation for the installed Spoon bundles if the documentation file is not present or the init.lua file for the Spoon has been modified more recently then the documentation file. Parameters:
Returns:
Notes:
|