Changed headerdoc markup to work better with CocoaDocs (closes #55).

1 files changed, 17 insertions, 17 deletions

diff --git a/Framework/MASShortcut.h b/Framework/MASShortcut.h
index 3e1bedf..8ba1b53 100644
--- a/Framework/MASShortcut.h
+++ b/Framework/MASShortcut.h
@@ -1,7 +1,7 @@
 #import "MASKeyCodes.h"
 
 /**
-    @brief A model class to hold a key combination.
+    A model class to hold a key combination.
 
     This class just represents a combination of keys. It does not care if
     the combination is valid or can be used as a hotkey, it doesn’t watch
@@ -11,49 +11,49 @@
 @interface MASShortcut : NSObject <NSSecureCoding, NSCopying>
 
 /**
-    @brief The virtual key code for the keyboard key.
+    The virtual key code for the keyboard key.
 
-    @Hardware independent, same as in NSEvent. Events.h in the HIToolbox
-    framework for a complete list, or Command-click this symbol: kVK_ANSI_A.
+    Hardware independent, same as in `NSEvent`. See `Events.h` in the HIToolbox
+    framework for a complete list, or Command-click this symbol: `kVK_ANSI_A`.
 */
 @property (nonatomic, readonly) NSUInteger keyCode;
 
 /**
-    @brief Cocoa keyboard modifier flags.
+    Cocoa keyboard modifier flags.
 
-    Same as in NSEvent: NSCommandKeyMask, NSAlternateKeyMask, etc.
+    Same as in `NSEvent`: `NSCommandKeyMask`, `NSAlternateKeyMask`, etc.
 */
 @property (nonatomic, readonly) NSUInteger modifierFlags;
 
 /**
-    @brief Same as @p keyCode, just a different type.
+    Same as `keyCode`, just a different type.
 */
 @property (nonatomic, readonly) UInt32 carbonKeyCode;
 
 /**
-    @brief Carbon modifier flags.
+    Carbon modifier flags.
 
-    A bit sum of @p cmdKey, @p optionKey, etc.
+    A bit sum of `cmdKey`, `optionKey`, etc.
 */
 @property (nonatomic, readonly) UInt32 carbonFlags;
 
 /**
-    @brief A string representing the “key” part of a shortcut, like the “5” in “⌘5”.
+    A string representing the “key” part of a shortcut, like the `5` in `⌘5`.
 */
 @property (nonatomic, readonly) NSString *keyCodeString;
 
 /**
-    @brief A key-code string used in key equivalent matching.
+    A key-code string used in key equivalent matching.
 
-    For precise meaning of “key equivalents” see the @p keyEquivalent
-    property of @p NSMenuItem. Here the string is used to support shortcut
+    For precise meaning of “key equivalents” see the `keyEquivalent`
+    property of `NSMenuItem`. Here the string is used to support shortcut
     validation (“is the shortcut already taken in this menu?”) and
-    for display in @p NSMenu.
+    for display in `NSMenu`.
 */
 @property (nonatomic, readonly) NSString *keyCodeStringForKeyEquivalent;
 
 /**
-    @brief A string representing the shortcut modifiers, like the “⌘” in “⌘5”.
+    A string representing the shortcut modifiers, like the `⌘` in `⌘5`.
 */
 @property (nonatomic, readonly) NSString *modifierFlagsString;
 
@@ -61,9 +61,9 @@
 + (instancetype)shortcutWithKeyCode:(NSUInteger)code modifierFlags:(NSUInteger)flags;
 
 /**
-    @brief Creates a new shortcut from an NSEvent object.
+    Creates a new shortcut from an `NSEvent` object.
 
-    This is just a convenience initializer that reads the key code and modifiers from an NSEvent.
+    This is just a convenience initializer that reads the key code and modifiers from an `NSEvent`.
 */
 + (instancetype)shortcutWithEvent:(NSEvent *)anEvent;