From 1094fd9a612a3d02109b04346ee17da75c701449 Mon Sep 17 00:00:00 2001
From: Tomáš Znamenáček
Date: Thu, 7 Aug 2014 18:20:37 +0200
Subject: Added header documentation.

---
 Framework/MASShortcutMonitor.h | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'Framework/MASShortcutMonitor.h')

diff --git a/Framework/MASShortcutMonitor.h b/Framework/MASShortcutMonitor.h
index 5c0daa2..609686a 100644
--- a/Framework/MASShortcutMonitor.h
+++ b/Framework/MASShortcutMonitor.h
@@ -1,10 +1,23 @@
 #import "MASShortcut.h"
 
+/**
+    @brief Executes action when a shortcut is pressed.
+
+    There can only be one instance of this class, otherwise things
+    will probably not work. (There’s a Carbon event handler inside
+    and there can only be one Carbon event handler of a given type.)
+*/
 @interface MASShortcutMonitor : NSObject
 
 - (instancetype) init __unavailable;
 + (instancetype) sharedMonitor;
 
+/**
+    @brief Register a shortcut along with an action.
+
+    Attempting to insert an already registered shortcut probably won’t work.
+    It may burn your house or cut your fingers. You have been warned.
+*/
 - (void) registerShortcut: (MASShortcut*) shortcut withAction: (dispatch_block_t) action;
 - (BOOL) isShortcutRegistered: (MASShortcut*) shortcut;
 
-- 
cgit v1.2.3