Document BSSourceView.h

diff --git a/Source/BSSourceView.h b/Source/BSSourceView.h
index 65517d434c6c5c23ec61181581c0724173ddcbbe..672ae64be385717e994e4463c7a221d7262fc48e 100644 (file)
--- a/Source/BSSourceView.h
+++ b/Source/BSSourceView.h
@@ -19,6 +19,12 @@
 @class BSLineNumberRulerView;
 @protocol BSSourceViewDelegate;
 
+// A BSSourceView is a view that contains an NSTextView that also has a line
+// number ruler. This class wraps synchronization management between the text
+// field and the line numbmering and marker drawing.
+//
+// Rather than setting the string of the text view directly, use the provided
+// methods to load from a file path or to load a string as a virtual file.
 @interface BSSourceView : NSView
 {
  @private
@@ -26,6 +32,7 @@
   BSLineNumberRulerView* ruler_;
   NSScrollView* scrollView_;
 
+  // Set of Breakpoint objects.
   NSSet* markers_;
 
   NSString* file;
@@ -34,8 +41,8 @@
   id<BSSourceViewDelegate> delegate;
 }
 
-@property (assign) NSTextView* textView;
-@property (assign) NSScrollView* scrollView;
+@property (readonly) NSTextView* textView;
+@property (readonly) NSScrollView* scrollView;
 @property (retain) NSSet* markers;
 @property (nonatomic, assign) NSString* file;
 @property (assign) int markedLine;