From f1e65c88dd49f99411724b523cf2331f5ba0473f Mon Sep 17 00:00:00 2001 From: Spiker985 Date: Sat, 25 Feb 2023 21:47:32 +0000 Subject: [PATCH] GH Action Documentation --- docs/Pulsar-API-Documentation.md | 298 +++++++++++++++++++++++++++++ docs/Source-Code-Documentation.md | 306 ++++++++++++++++++++++++++++++ 2 files changed, 604 insertions(+) diff --git a/docs/Pulsar-API-Documentation.md b/docs/Pulsar-API-Documentation.md index e69de29bb..f5e7e39b7 100644 --- a/docs/Pulsar-API-Documentation.md +++ b/docs/Pulsar-API-Documentation.md @@ -0,0 +1,298 @@ +## Classes + +
+
AtomEnvironment
+

Pulsar global for dealing with packages, themes, menus, and the window.

+

An instance of this class is always available as the atom global.

+
+
Clipboard
+
+
+ +## Constants + +
+
etch
+
+
fs
+
+
dalek
+
+
assert
+
+
+ +## Functions + +
+
beforeEach()
+
+
beforeEach()
+
+
conditionPromise()
+
+
destroy()
+
+
destroyChildren()
+
+
releaseChildren()
+
+
subscribeToRepository()
+
+
updateDiffs()
+
+
beforeEach()
+
+
beforeEach()
+
+
beforeEach()
+
+
conditionPromise()
+
+
beforeEach()
+
+
+ + + +## AtomEnvironment +Pulsar global for dealing with packages, themes, menus, and the window. + +An instance of this class is always available as the `atom` global. + +**Kind**: global class + +* [AtomEnvironment](#AtomEnvironment) + * _instance_ + * [.clipboard](#AtomEnvironment+clipboard) : [Clipboard](#Clipboard) + * [.deserializers](#AtomEnvironment+deserializers) : DeserializerManager + * [.views](#AtomEnvironment+views) : ViewRegistry + * [.notifications](#AtomEnvironment+notifications) : NotificationManager + * [.config](#AtomEnvironment+config) : Config + * [.keymaps](#AtomEnvironment+keymaps) : KeymapManager + * [.tooltips](#AtomEnvironment+tooltips) : TooltipManager + * [.commands](#AtomEnvironment+commands) : CommandRegistry + * [.grammars](#AtomEnvironment+grammars) : GrammarRegistry + * [.styles](#AtomEnvironment+styles) : StyleManager + * [.packages](#AtomEnvironment+packages) : PackageManager + * [.themes](#AtomEnvironment+themes) : ThemeManager + * [.menu](#AtomEnvironment+menu) : MenuManager + * [.contextMenu](#AtomEnvironment+contextMenu) : ContextMenuManager + * [.project](#AtomEnvironment+project) : Project + * [.textEditors](#AtomEnvironment+textEditors) : TextEditorRegistry + * [.workspace](#AtomEnvironment+workspace) : Workspace + * [.history](#AtomEnvironment+history) : HistoryManager + * _Messaging the User_ + * [.beep()](#AtomEnvironment+beep) + * _static_ + * _Event Subscription_ + * [.onDidBeep(callback)](#AtomEnvironment.onDidBeep) ⇒ Disposable + + + +### atomEnvironment.clipboard : [Clipboard](#Clipboard) +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.deserializers : DeserializerManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.views : ViewRegistry +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.notifications : NotificationManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.config : Config +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.keymaps : KeymapManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.tooltips : TooltipManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.commands : CommandRegistry +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.grammars : GrammarRegistry +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.styles : StyleManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.packages : PackageManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.themes : ThemeManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.menu : MenuManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.contextMenu : ContextMenuManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.project : Project +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.textEditors : TextEditorRegistry +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.workspace : Workspace +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.history : HistoryManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.beep() +Visually and audibly trigger a beep. + +**Kind**: instance method of [AtomEnvironment](#AtomEnvironment) +**Category**: Messaging the User +**Emits**: event:beep + + +### AtomEnvironment.onDidBeep(callback) ⇒ Disposable +Invoke the given callback whenever [::beep](::beep) is called. + +**Kind**: static method of [AtomEnvironment](#AtomEnvironment) +**Returns**: Disposable - on which `.dispose()` can be called to unsubscribe. +**Category**: Event Subscription + +| Param | Type | Description | +| --- | --- | --- | +| callback | function | Function to be called whenever [::beep](::beep) is called. | + + + +## Clipboard +**Kind**: global class + + +### new Clipboard() +Represents the clipboard used for copying and pasting in Pulsar. + +An instance of this class is always available as the `atom.clipboard` global. + +**Example** +```js +// returns 'hello' +atom.clipboard.write('hello'); + +console.log(atom.clipboard.read()); +``` + + +## etch +**Kind**: global constant +**Jsx**: etch.dom + + +## fs +**Kind**: global constant +**Babel**: + + +## dalek +**Kind**: global constant +**Babel**: + + +## assert +**Kind**: global constant +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## conditionPromise() +**Kind**: global function +**Babel**: + + +## destroy() +**Kind**: global function +**Describe**: Handles tear down of destructables and subscriptions. + Does not handle release of memory. This method should only be called + just before this object is freed, and should only tear down the main + object components that are guarunteed to exist at all times. + + +## destroyChildren() +**Kind**: global function +**Describe**: Destroys this objects children (non-freeing), it's intended + to be an ease-of use function for maintaing this object. This method + should only tear down objects that are selectively allocated upon + repository discovery. + + Example: this.diffs only exists when we have a repository. + + +## releaseChildren() +**Kind**: global function +**Describe**: The memory releasing complement function of `destroyChildren`. + frees the memory allocated at all child object storage locations + when there is no repository. + + +## subscribeToRepository() +**Kind**: global function +**Describe**: handles all subscriptions based on the repository in focus + + +## updateDiffs() +**Kind**: global function +**Describe**: Uses text markers in the target editor to visualize + git modifications, additions, and deletions. The current algorithm + just redraws the markers each call. + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## conditionPromise() +**Kind**: global function +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: diff --git a/docs/Source-Code-Documentation.md b/docs/Source-Code-Documentation.md index e69de29bb..f19274580 100644 --- a/docs/Source-Code-Documentation.md +++ b/docs/Source-Code-Documentation.md @@ -0,0 +1,306 @@ +## Classes + +
+
AtomEnvironment
+

Pulsar global for dealing with packages, themes, menus, and the window.

+

An instance of this class is always available as the atom global.

+
+
Clipboard
+
+
+ +## Constants + +
+
etch
+
+
fs
+
+
dalek
+
+
assert
+
+
+ +## Functions + +
+
beforeEach()
+
+
beforeEach()
+
+
conditionPromise()
+
+
destroy()
+
+
destroyChildren()
+
+
releaseChildren()
+
+
subscribeToRepository()
+
+
updateDiffs()
+
+
beforeEach()
+
+
beforeEach()
+
+
beforeEach()
+
+
conditionPromise()
+
+
beforeEach()
+
+
+ + + +## AtomEnvironment +Pulsar global for dealing with packages, themes, menus, and the window. + +An instance of this class is always available as the `atom` global. + +**Kind**: global class + +* [AtomEnvironment](#AtomEnvironment) + * _instance_ + * [.clipboard](#AtomEnvironment+clipboard) : [Clipboard](#Clipboard) + * [.deserializers](#AtomEnvironment+deserializers) : DeserializerManager + * [.views](#AtomEnvironment+views) : ViewRegistry + * [.notifications](#AtomEnvironment+notifications) : NotificationManager + * [.config](#AtomEnvironment+config) : Config + * [.keymaps](#AtomEnvironment+keymaps) : KeymapManager + * [.tooltips](#AtomEnvironment+tooltips) : TooltipManager + * [.commands](#AtomEnvironment+commands) : CommandRegistry + * [.grammars](#AtomEnvironment+grammars) : GrammarRegistry + * [.styles](#AtomEnvironment+styles) : StyleManager + * [.packages](#AtomEnvironment+packages) : PackageManager + * [.themes](#AtomEnvironment+themes) : ThemeManager + * [.menu](#AtomEnvironment+menu) : MenuManager + * [.contextMenu](#AtomEnvironment+contextMenu) : ContextMenuManager + * [.project](#AtomEnvironment+project) : Project + * [.textEditors](#AtomEnvironment+textEditors) : TextEditorRegistry + * [.workspace](#AtomEnvironment+workspace) : Workspace + * [.history](#AtomEnvironment+history) : HistoryManager + * _Messaging the User_ + * [.beep()](#AtomEnvironment+beep) + * _static_ + * [.preloadPackages](#AtomEnvironment.preloadPackages) ℗ + * _Event Subscription_ + * [.onDidBeep(callback)](#AtomEnvironment.onDidBeep) ⇒ Disposable + + + +### atomEnvironment.clipboard : [Clipboard](#Clipboard) +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.deserializers : DeserializerManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.views : ViewRegistry +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.notifications : NotificationManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.config : Config +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.keymaps : KeymapManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.tooltips : TooltipManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.commands : CommandRegistry +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.grammars : GrammarRegistry +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.styles : StyleManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.packages : PackageManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.themes : ThemeManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.menu : MenuManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.contextMenu : ContextMenuManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.project : Project +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.textEditors : TextEditorRegistry +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.workspace : Workspace +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.history : HistoryManager +**Kind**: instance property of [AtomEnvironment](#AtomEnvironment) + + +### atomEnvironment.beep() +Visually and audibly trigger a beep. + +**Kind**: instance method of [AtomEnvironment](#AtomEnvironment) +**Category**: Messaging the User +**Emits**: event:beep + + +### AtomEnvironment.preloadPackages ℗ +Returns output of `preloadPackages()` for this Classes Instance of `Packages`. + +**Kind**: static property of [AtomEnvironment](#AtomEnvironment) +**Access**: private + + +### AtomEnvironment.onDidBeep(callback) ⇒ Disposable +Invoke the given callback whenever [::beep](::beep) is called. + +**Kind**: static method of [AtomEnvironment](#AtomEnvironment) +**Returns**: Disposable - on which `.dispose()` can be called to unsubscribe. +**Category**: Event Subscription + +| Param | Type | Description | +| --- | --- | --- | +| callback | function | Function to be called whenever [::beep](::beep) is called. | + + + +## Clipboard +**Kind**: global class + + +### new Clipboard() +Represents the clipboard used for copying and pasting in Pulsar. + +An instance of this class is always available as the `atom.clipboard` global. + +**Example** +```js +// returns 'hello' +atom.clipboard.write('hello'); + +console.log(atom.clipboard.read()); +``` + + +## etch +**Kind**: global constant +**Jsx**: etch.dom + + +## fs +**Kind**: global constant +**Babel**: + + +## dalek +**Kind**: global constant +**Babel**: + + +## assert +**Kind**: global constant +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## conditionPromise() +**Kind**: global function +**Babel**: + + +## destroy() +**Kind**: global function +**Describe**: Handles tear down of destructables and subscriptions. + Does not handle release of memory. This method should only be called + just before this object is freed, and should only tear down the main + object components that are guarunteed to exist at all times. + + +## destroyChildren() +**Kind**: global function +**Describe**: Destroys this objects children (non-freeing), it's intended + to be an ease-of use function for maintaing this object. This method + should only tear down objects that are selectively allocated upon + repository discovery. + + Example: this.diffs only exists when we have a repository. + + +## releaseChildren() +**Kind**: global function +**Describe**: The memory releasing complement function of `destroyChildren`. + frees the memory allocated at all child object storage locations + when there is no repository. + + +## subscribeToRepository() +**Kind**: global function +**Describe**: handles all subscriptions based on the repository in focus + + +## updateDiffs() +**Kind**: global function +**Describe**: Uses text markers in the target editor to visualize + git modifications, additions, and deletions. The current algorithm + just redraws the markers each call. + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: + + +## conditionPromise() +**Kind**: global function +**Babel**: + + +## beforeEach() +**Kind**: global function +**Babel**: