aboutsummaryrefslogtreecommitdiffstats
path: root/docs.json
diff options
context:
space:
mode:
authorTeddy Wing2019-06-16 16:16:05 +0200
committerTeddy Wing2019-06-16 16:16:05 +0200
commit7faa8cb130485a8cd716b1d1869a3cc7235e0482 (patch)
treef57f11a780380e65a8cf49da0d15a275ffe82ace /docs.json
parent5ebc74fb9cf62118345e646d7b04e7a173890a38 (diff)
downloadWindowMode.spoon-7faa8cb130485a8cd716b1d1869a3cc7235e0482.tar.bz2
Add documentation
Used the following Spoons as a format reference: - https://github.com/Hammerspoon/Spoons/blob/master/Source/Tunnelblick.spoon/init.lua - https://github.com/Hammerspoon/Spoons/blob/master/Source/Token.spoon/init.lua The Spoons documentation describes how to generate a required `docs.json` file: https://github.com/Hammerspoon/hammerspoon/blob/master/SPOONS.md Thanks to Adam Matan (https://stackoverflow.com/users/51197/adam-matan) on Stack Overflow for the tip on Make's `CURDIR` variable. Didn't know that existed. https://stackoverflow.com/questions/52437728/bash-what-is-the-difference-between-pwd-and-curdir/52447088#52447088
Diffstat (limited to 'docs.json')
-rw-r--r--docs.json83
1 files changed, 83 insertions, 0 deletions
diff --git a/docs.json b/docs.json
new file mode 100644
index 0000000..269959e
--- /dev/null
+++ b/docs.json
@@ -0,0 +1,83 @@
+[
+ {
+ "Constant" : [
+
+ ],
+ "submodules" : [
+
+ ],
+ "Function" : [
+
+ ],
+ "Variable" : [
+
+ ],
+ "stripped_doc" : [
+
+ ],
+ "desc" : "Adds a hotkey mode for manipulating windows.",
+ "type" : "Module",
+ "Deprecated" : [
+
+ ],
+ "Constructor" : [
+
+ ],
+ "doc" : "Adds a hotkey mode for manipulating windows.\n\nUpon activating the mode, the following shortcuts are available:\n\nh: Move window left 20 units\nj: Move window down 20 units\nk: Move window up 20 units\nl: Move window right 20 units\n\nShift-h: Move window left 5 units\nShift-j: Move window down 5 units\nShift-k: Move window up 5 units\nShift-l: Move window right 5 units\n\n[: Move window left one screen\n]: Move window right one screen\n\ne: Reduce window height 20 units\ns: Reduce window width 20 units\nd: Increase window height 20 units\nf: Increase window width 20 units\n\nShift-e: Reduce window height 5 units\nShift-s: Reduce window width 5 units\nShift-d: Increase window height 5 units\nShift-f: Increase window width 5 units",
+ "Field" : [
+
+ ],
+ "Command" : [
+
+ ],
+ "items" : [
+ {
+ "doc" : "Bind keys for WindowMode\n\nParameters:\n * mapping – A table containing hotkey modifier\/key details for the following items:\n * mode – Activate and deactivate window mode",
+ "desc" : "Bind keys for WindowMode",
+ "stripped_doc" : [
+ "Bind keys for WindowMode",
+ ""
+ ],
+ "parameters" : [
+ " * mapping – A table containing hotkey modifier\/key details for the following items:",
+ " * mode – Activate and deactivate window mode"
+ ],
+ "notes" : [
+
+ ],
+ "signature" : "WindowMode:bindModal(mapping)",
+ "type" : "Method",
+ "returns" : [
+
+ ],
+ "def" : "WindowMode:bindModal(mapping)",
+ "name" : "bindModal"
+ }
+ ],
+ "Method" : [
+ {
+ "doc" : "Bind keys for WindowMode\n\nParameters:\n * mapping – A table containing hotkey modifier\/key details for the following items:\n * mode – Activate and deactivate window mode",
+ "desc" : "Bind keys for WindowMode",
+ "stripped_doc" : [
+ "Bind keys for WindowMode",
+ ""
+ ],
+ "parameters" : [
+ " * mapping – A table containing hotkey modifier\/key details for the following items:",
+ " * mode – Activate and deactivate window mode"
+ ],
+ "notes" : [
+
+ ],
+ "signature" : "WindowMode:bindModal(mapping)",
+ "type" : "Method",
+ "returns" : [
+
+ ],
+ "def" : "WindowMode:bindModal(mapping)",
+ "name" : "bindModal"
+ }
+ ],
+ "name" : "WindowMode"
+ }
+]