Skip to content

Commit

Permalink
Tweaked API docs formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@latenitefilms
latenitefilms committed Jun 9, 2023
1 parent a360a3c commit 8f2710b
Show file tree
Hide file tree
Showing 613 changed files with 14,055 additions and 6,125 deletions.
5 changes: 3 additions & 2 deletions docs/api-references/commandpost/cp.18n.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ CommandPost's Internationalisation & Localisation Manger.

## API Documentation

### Functions
#### Functions


### [init](#init)
Expand All @@ -25,6 +25,7 @@ CommandPost's Internationalisation & Localisation Manger.
| **Description** | Initialise the module. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>None</li></ul> |
| **Notes** | <ul></ul> |
| **Notes** | <ul></ul> |

---

4 changes: 3 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 @@ -13,7 +13,7 @@ The `cp.app` for Adobe After Effects.

## API Documentation

### Constants
#### Constants


### [app](#app)
Expand All @@ -23,5 +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 |

---

24 changes: 16 additions & 8 deletions docs/api-references/commandpost/cp.adobe.aftereffects.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Adobe After Effects Extension

## API Documentation

### Constants
#### Constants


### [preferences](#preferences)
Expand All @@ -37,9 +37,11 @@ Adobe After Effects Extension
| **Signature** | `cp.adobe.aftereffects.preferences <cp.app.prefs>` |
| **Type** | Constant |
| **Description** | The `cp.app.prefs` for After Effects. |
| **Notes** | - None |

---
### Functions

#### Functions


### [allowScriptsToWriteFilesAndAccessNetwork](#allowscriptstowritefilesandaccessnetwork)
Expand All @@ -51,10 +53,11 @@ 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> |
| **Notes** | <ul></ul> |

---


### [preferencesFilePath](#preferencesfilepath)

| | |
Expand All @@ -64,10 +67,11 @@ 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> |
| **Notes** | <ul></ul> |

---


### [preferencesPath](#preferencespath)

| | |
Expand All @@ -77,10 +81,11 @@ 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> |
| **Notes** | <ul></ul> |

---


### [refreshPreferences](#refreshpreferences)

| | |
Expand All @@ -90,10 +95,11 @@ 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> |
| **Notes** | <ul></ul> |

---


### [shortcutsPreferences](#shortcutspreferences)

| | |
Expand All @@ -103,10 +109,11 @@ 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> |
| **Notes** | <ul></ul> |

---


### [shortcutsPreferencesPath](#shortcutspreferencespath)

| | |
Expand All @@ -116,6 +123,7 @@ 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> |
| **Notes** | <ul></ul> |

---

8 changes: 7 additions & 1 deletion docs/api-references/commandpost/cp.adobe.aftereffects.shortcuts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Translations between After Effects shortcuts and Hammerspoon-friendly shortcuts.

## API Documentation

### Constants
#### Constants


### [keys](#keys)
Expand All @@ -25,25 +25,31 @@ 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 |

---


### [labels](#labels)

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

---


### [modifiers](#modifiers)

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

---

Loading

0 comments on commit 8f2710b

Please sign in to comment.