Skip to content

Commit

Permalink
Improved API Reference Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@latenitefilms
latenitefilms committed Jun 9, 2023
1 parent ea9aaa2 commit fd23595
Show file tree
Hide file tree
Showing 613 changed files with 9,539 additions and 9,539 deletions.
4 changes: 2 additions & 2 deletions docs/api-references/commandpost/cp.18n.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ CommandPost's Internationalisation & Localisation Manger.
| **Description** | Initialise the module. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>None</li></ul> |
| **Notes** | <ul></ul> |
| **Examples** | <ul></ul> |
| **Notes** | <ul><li>None</li></ul> |
| **Examples** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/i18n/init.lua line 26](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/i18n/init.lua#L26) |

---
Expand Down
2 changes: 1 addition & 1 deletion docs/api-references/commandpost/cp.adobe.aftereffects.app.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The `cp.app` for Adobe After Effects.
| **Signature** | `cp.adobe.aftereffects.app <cp.app>` |
| **Type** | Constant |
| **Description** | The `cp.app` for After Effects. |
| **Notes** | - None |
| **Notes** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/init.lua line 30](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/init.lua#L30) |

---
Expand Down
26 changes: 13 additions & 13 deletions docs/api-references/commandpost/cp.adobe.aftereffects.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Adobe After Effects Extension
| **Signature** | `cp.adobe.aftereffects.preferences <cp.app.prefs>` |
| **Type** | Constant |
| **Description** | The `cp.app.prefs` for After Effects. |
| **Notes** | - None |
| **Notes** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/init.lua line 35](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/init.lua#L35) |

---
Expand All @@ -54,8 +54,8 @@ Adobe After Effects Extension
| **Description** | Is "Allow Scripts to Write Files and Access Network" enabled in After Effects Preferences? |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A boolean</li></ul> |
| **Notes** | <ul></ul> |
| **Examples** | <ul></ul> |
| **Notes** | <ul><li>None</li></ul> |
| **Examples** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/init.lua line 82](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/init.lua#L82) |

---
Expand All @@ -70,8 +70,8 @@ Adobe After Effects Extension
| **Description** | The path to the main Preferences file. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A string</li></ul> |
| **Notes** | <ul></ul> |
| **Examples** | <ul></ul> |
| **Notes** | <ul><li>None</li></ul> |
| **Examples** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/init.lua line 62](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/init.lua#L62) |

---
Expand All @@ -86,8 +86,8 @@ Adobe After Effects Extension
| **Description** | The path to After Effects Preferences folder. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A string or `nil` if no path can be found.</li></ul> |
| **Notes** | <ul></ul> |
| **Examples** | <ul></ul> |
| **Notes** | <ul><li>None</li></ul> |
| **Examples** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/init.lua line 43](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/init.lua#L43) |

---
Expand All @@ -102,8 +102,8 @@ Adobe After Effects Extension
| **Description** | If After Effects is running, this forces the preferences file to be saved to disk. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>None</li></ul> |
| **Notes** | <ul></ul> |
| **Examples** | <ul></ul> |
| **Notes** | <ul><li>None</li></ul> |
| **Examples** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/init.lua line 97](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/init.lua#L97) |

---
Expand All @@ -118,8 +118,8 @@ Adobe After Effects Extension
| **Description** | Gets a table of all the active After Effects keyboard shortcuts. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A table</li></ul> |
| **Notes** | <ul></ul> |
| **Examples** | <ul></ul> |
| **Notes** | <ul><li>None</li></ul> |
| **Examples** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/init.lua line 201](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/init.lua#L201) |

---
Expand All @@ -134,8 +134,8 @@ Adobe After Effects Extension
| **Description** | Gets the active shortcut key preferences file path. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A string</li></ul> |
| **Notes** | <ul></ul> |
| **Examples** | <ul></ul> |
| **Notes** | <ul><li>None</li></ul> |
| **Examples** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/init.lua line 116](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/init.lua#L116) |

---
Expand Down
6 changes: 3 additions & 3 deletions docs/api-references/commandpost/cp.adobe.aftereffects.shortcuts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Translations between After Effects shortcuts and Hammerspoon-friendly shortcuts.
| **Signature** | `cp.adobe.aftereffects.shortcuts.keys -> table` |
| **Type** | Constant |
| **Description** | Table containing key translations. |
| **Notes** | - None |
| **Notes** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/shortcuts.lua line 766](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/shortcuts.lua#L766) |

---
Expand All @@ -38,7 +38,7 @@ Translations between After Effects shortcuts and Hammerspoon-friendly shortcuts.
| **Signature** | `cp.adobe.aftereffects.shortcuts.labels -> table` |
| **Type** | Constant |
| **Description** | Table containing label translations. |
| **Notes** | - None |
| **Notes** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/shortcuts.lua line 6](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/shortcuts.lua#L6) |

---
Expand All @@ -51,7 +51,7 @@ Translations between After Effects shortcuts and Hammerspoon-friendly shortcuts.
| **Signature** | `cp.adobe.aftereffects.shortcuts.modifiers -> table` |
| **Type** | Constant |
| **Description** | Table containing modifier translations. |
| **Notes** | - None |
| **Notes** | <ul><li>None</li></ul> |
| **Source** | [src/extensions/cp/adobe/aftereffects/shortcuts.lua line 973](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/adobe/aftereffects/shortcuts.lua#L973) |

---
Expand Down
Loading

0 comments on commit fd23595

Please sign in to comment.