Readability review for Obj-C for feldstein

Readibility review code using the cocoa browser accessibility stuff for
objective c

Review URL: http://codereview.chromium.org/2951011

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@53723 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 19 insertions, 5 deletions

diff --git a/chrome/browser/cocoa/browser_accessibility.h b/chrome/browser/cocoa/browser_accessibility.h
index 3c8683a..32af50e 100644
--- a/chrome/browser/cocoa/browser_accessibility.h
+++ b/chrome/browser/cocoa/browser_accessibility.h
@@ -9,15 +9,15 @@
 #import <Cocoa/Cocoa.h>
 
 #import "base/scoped_nsobject.h"
-#include "chrome/browser/cocoa/browser_accessibility_delegate.h"
+#import "chrome/browser/cocoa/browser_accessibility_delegate.h"
 #include "webkit/glue/webaccessibility.h"
 
 using webkit_glue::WebAccessibility;
 
 // BrowserAccessibility is a cocoa wrapper around the WebAccessibility
 // object. The renderer converts webkit's accessibility tree into a
-// WebAccessibility tree and passes it to us over IPC.  This class
-// converts it into a format Cocoa can query.
+// WebAccessibility tree and passes it to the browser process over IPC.
+// This class converts it into a format Cocoa can query.
 @interface BrowserAccessibility : NSObject {
  @private
   WebAccessibility webAccessibility_;
@@ -25,17 +25,31 @@ using webkit_glue::WebAccessibility;
   scoped_nsobject<NSMutableArray> children_;
   // The parent of the accessibility object.  This can be another
   // BrowserAccessibility or a RenderWidgetHostViewCocoa.
-  id parent_;
+  id parent_;  // weak
 }
 
-- (id)initWithObject:(const WebAccessibility)accessibility
+// This creates a cocoa browser accessibility object around
+// the webkit glue WebAccessibility object.  The delegate is
+// used to communicate with the host renderer.  None of these
+// parameters can be null.
+- (id)initWithObject:(const WebAccessibility&)accessibility
             delegate:(id<BrowserAccessibilityDelegate>)delegate
               parent:(id)parent;
 
+// Children is an array of BrowserAccessibility objects, representing
+// the accessibility children of this object.
 @property(nonatomic, readonly) NSArray* children;
+// isIgnored returns whether or not the accessibility object
+// should be ignored by the accessibility hierarchy.
 @property(nonatomic, readonly, getter=isIgnored) BOOL ignored;
+// The origin of this object in the page's document.
+// This is relative to webkit's top-left origin, not Cocoa's
+// bottom-left origin.
 @property(nonatomic, readonly) NSPoint origin;
+// A string indicating the role of this object as far as accessibility
+// is concerned.
 @property(nonatomic, readonly) NSString* role;
+// The size of this object.
 @property(nonatomic, readonly) NSSize size;
 
 @end