From 23a5b83ea6c3ae9a59661a5f0bb903f66f36cc51 Mon Sep 17 00:00:00 2001
From: Aparajita Fishman <aparajita@vasudevaserver.org>
Date: Tue, 10 May 2011 19:20:37 -0400
Subject: [PATCH] Corrected and added -performKeyEquivalent docs.

---
 AppKit/CPResponder.j | 17 ++++++++++++-----
 AppKit/CPView.j      | 14 ++++++++++++++
 2 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/AppKit/CPResponder.j b/AppKit/CPResponder.j
index 8890dc63e..73199a1b5 100644
--- a/AppKit/CPResponder.j
+++ b/AppKit/CPResponder.j
@@ -231,11 +231,18 @@ CPDeleteForwardKeyCode  = 46;
     [_nextResponder performSelector:_cmd withObject:anEvent];
 }
 
-/*
-    FIXME This description is bad.
-    Based on \c anEvent, the receiver should simulate the event.
-    @param anEvent the event to simulate
-    @return \c YES if the event receiver simulated the  event
+/*!
+    Overridden by subclasses to handle a key equivalent.
+
+    If the character code or codes in \c anEvent match the receiver’s key equivalent,
+    the receiver should respond to the event and return \c YES. The default implementation
+    does nothing and returns \c NO.
+
+    You should extract the characters for a key equivalent using
+    \ref CPEvent::charactersIgnoringModifiers "[anEvent charactersIgnoringModifiers]".
+
+    @param anEvent An event object that represents the key equivalent pressed
+    @return \c YES if theEvent is a key equivalent that the receiver handled, \c NO if it is not a key equivalent that it should handle.
 */
 - (BOOL)performKeyEquivalent:(CPEvent)anEvent
 {
diff --git a/AppKit/CPView.j b/AppKit/CPView.j
index 58b37ea70..83ea1842d 100644
--- a/AppKit/CPView.j
+++ b/AppKit/CPView.j
@@ -2129,6 +2129,20 @@ setBoundsOrigin:
 
 @implementation CPView (KeyView)
 
+/*!
+    Overridden by subclasses to handle a key equivalent.
+
+    If the receiver’s key equivalent is the same as the characters of the key-down event theEvent,
+    as returned by \ref CPEvent::charactersIgnoringModifiers "[anEvent charactersIgnoringModifiers]",
+    the receiver should take the appropriate action and return \c YES. Otherwise, it should return
+    the result of invoking super’s implementation. The default implementation of this method simply
+    passes the message down the view hierarchy (from superviews to subviews)
+    and returns \c NO if none of the receiver’s subviews responds \c YES.
+
+    @param anEvent An event object that represents the key equivalent pressed
+    @return \c YES if theEvent is a key equivalent that the receiver handled,
+            \c NO if it is not a key equivalent that it should handle.
+*/
 - (BOOL)performKeyEquivalent:(CPEvent)anEvent
 {
     var count = [_subviews count];