From 7faa8cb130485a8cd716b1d1869a3cc7235e0482 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Sun, 16 Jun 2019 16:16:05 +0200
Subject: 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
---
 init.lua | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

(limited to 'init.lua')

diff --git a/init.lua b/init.lua
index b6654de..6f6f837 100644
--- a/init.lua
+++ b/init.lua
@@ -1,3 +1,32 @@
+--- === WindowMode ===
+---
+--- Adds a hotkey mode for manipulating windows.
+---
+--- Upon activating the mode, the following shortcuts are available:
+---
+--- h: Move window left 20 units
+--- j: Move window down 20 units
+--- k: Move window up 20 units
+--- l: Move window right 20 units
+---
+--- Shift-h: Move window left 5 units
+--- Shift-j: Move window down 5 units
+--- Shift-k: Move window up 5 units
+--- Shift-l: Move window right 5 units
+---
+--- [: Move window left one screen
+--- ]: Move window right one screen
+---
+--- e: Reduce window height 20 units
+--- s: Reduce window width 20 units
+--- d: Increase window height 20 units
+--- f: Increase window width 20 units
+---
+--- Shift-e: Reduce window height 5 units
+--- Shift-s: Reduce window width 5 units
+--- Shift-d: Increase window height 5 units
+--- Shift-f: Increase window width 5 units
+
 -- Copyright (c) 2019  Teddy Wing
 --
 -- This program is free software: you can redistribute it and/or modify
@@ -31,6 +60,13 @@ obj.spoonPath = script_path()
 
 local window = dofile(obj.spoonPath .. '/window.lua')
 
+--- WindowMode:bindModal(mapping)
+--- Method
+--- Bind keys for WindowMode
+---
+--- Parameters:
+---  * mapping – A table containing hotkey modifier/key details for the following items:
+---   * mode – Activate and deactivate window mode
 function obj:bindHotkeys(keys)
 	local mode = keys['mode']
 	window:bindModal(mode[1], mode[2])
-- 
cgit v1.2.3