Skip to content

Commit

Permalink
Attempting to improve API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@latenitefilms
latenitefilms committed Jun 9, 2023
1 parent af6a20b commit 100f63d
Show file tree
Hide file tree
Showing 613 changed files with 31,645 additions and 6,329 deletions.
6 changes: 5 additions & 1 deletion docs/api-references/commandpost/cp.18n.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ CommandPost's Internationalisation & Localisation Manger.

### Functions

| [init](#init) | |

### [init](#init)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.18n.init() -> none` |
| **Type** | Function |
Expand All @@ -19,3 +22,4 @@ CommandPost's Internationalisation & Localisation Manger.
| **Returns** | <ul><li>None</li></ul> |
| **Notes** | <ul></ul> |

---
6 changes: 5 additions & 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 @@ -10,9 +10,13 @@ The `cp.app` for Adobe After Effects.

### Constants

| [app](#app) | |

### [app](#app)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects.app <cp.app>` |
| **Type** | Constant |
| **Description** | The `cp.app` for After Effects. |

---
42 changes: 35 additions & 7 deletions docs/api-references/commandpost/cp.adobe.aftereffects.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,22 @@ Adobe After Effects Extension

### Constants

| [preferences](#preferences) | |

### [preferences](#preferences)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects.preferences <cp.app.prefs>` |
| **Type** | Constant |
| **Description** | The `cp.app.prefs` for After Effects. |

---
### Functions

| [allowScriptsToWriteFilesAndAccessNetwork](#allowScriptsToWriteFilesAndAccessNetwork) | |

### [allowScriptsToWriteFilesAndAccessNetwork](#allowScriptsToWriteFilesAndAccessNetwork)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects:allowScriptsToWriteFilesAndAccessNetwork() -> boolean` |
| **Type** | Function |
Expand All @@ -38,7 +45,11 @@ Adobe After Effects Extension
| **Returns** | <ul><li>A boolean</li></ul> |
| **Notes** | <ul></ul> |

| [preferencesFilePath](#preferencesFilePath) | |
---

### [preferencesFilePath](#preferencesFilePath)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects:preferencesFilePath() -> string` |
| **Type** | Function |
Expand All @@ -47,7 +58,11 @@ Adobe After Effects Extension
| **Returns** | <ul><li>A string</li></ul> |
| **Notes** | <ul></ul> |

| [preferencesPath](#preferencesPath) | |
---

### [preferencesPath](#preferencesPath)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects:preferencesPath() -> string | nil` |
| **Type** | Function |
Expand All @@ -56,7 +71,11 @@ Adobe After Effects Extension
| **Returns** | <ul><li>A string or `nil` if no path can be found.</li></ul> |
| **Notes** | <ul></ul> |

| [refreshPreferences](#refreshPreferences) | |
---

### [refreshPreferences](#refreshPreferences)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects:refreshPreferences() -> none` |
| **Type** | Function |
Expand All @@ -65,7 +84,11 @@ Adobe After Effects Extension
| **Returns** | <ul><li>None</li></ul> |
| **Notes** | <ul></ul> |

| [shortcutsPreferences](#shortcutsPreferences) | |
---

### [shortcutsPreferences](#shortcutsPreferences)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects:shortcutsPreferences() -> table` |
| **Type** | Function |
Expand All @@ -74,7 +97,11 @@ Adobe After Effects Extension
| **Returns** | <ul><li>A table</li></ul> |
| **Notes** | <ul></ul> |

| [shortcutsPreferencesPath](#shortcutsPreferencesPath) | |
---

### [shortcutsPreferencesPath](#shortcutsPreferencesPath)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects:shortcutsPreferencesPath() -> string` |
| **Type** | Function |
Expand All @@ -83,3 +110,4 @@ Adobe After Effects Extension
| **Returns** | <ul><li>A string</li></ul> |
| **Notes** | <ul></ul> |

---
18 changes: 15 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 @@ -12,21 +12,33 @@ Translations between After Effects shortcuts and Hammerspoon-friendly shortcuts.

### Constants

| [keys](#keys) | |

### [keys](#keys)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects.shortcuts.keys -> table` |
| **Type** | Constant |
| **Description** | Table containing key translations. |

| [labels](#labels) | |
---

### [labels](#labels)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects.shortcuts.labels -> table` |
| **Type** | Constant |
| **Description** | Table containing label translations. |

| [modifiers](#modifiers) | |
---

### [modifiers](#modifiers)

| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.adobe.aftereffects.shortcuts.modifiers -> table` |
| **Type** | Constant |
| **Description** | Table containing modifier translations. |

---
Loading

0 comments on commit 100f63d

Please sign in to comment.