Permalink
Browse files

Updated headers for doxygen

Simple header updates to generate better documentation when the
documentation target is selected.  Updated gitignore to strip out
generated documentation; best to build / rebuild this from source.
  • Loading branch information...
1 parent 843d157 commit 0873d28ab431581907fd98b37aa94c915c2c420f @epreston committed Aug 26, 2011
View
@@ -8,6 +8,9 @@ Thumbs.db
# Backup files
*~.nib
+# Generated Docs
+Documentation/*
+
# Xcode Specific Files
build/*
*.pbxuser
@@ -17,13 +17,13 @@
@class PSBaseTreeGraphView;
-// Each SubtreeView has a BranchView subview that draws the connecting lines between its root node
-// and its child subtrees.
+/// Each SubtreeView has a BranchView subview that draws the connecting lines between its root node
+/// and its child subtrees.
@interface PSBaseBranchView : UIView
-// Link to the enclosing TreeGraph. (The getter for this is a convenience method that ascends the view tree
-// until it encounters a TreeGraph.)
+/// Link to the enclosing TreeGraph. (The getter for this is a convenience method that ascends the view tree
+/// until it encounters a TreeGraph.)
@property (nonatomic, readonly) PSBaseTreeGraphView *enclosingTreeGraph;
@@ -15,8 +15,8 @@
#import <UIKit/UIKit.h>
-// Draws background fill and a stroked, optionally rounded rectangular shape. Serves as a container
-// for other views (in our case, we use a ContainerView as the root of each node subtree).
+/// Draws background fill and a stroked, optionally rounded rectangular shape. Serves as a container
+/// for other views (in our case, we use a ContainerView as the root of each node subtree).
@interface PSBaseLeafView : UIView
{
@@ -34,16 +34,16 @@
#pragma mark - Styling
-//The color of the ContainerView's stroked border.
+/// The color of the ContainerView's stroked border.
@property (nonatomic, copy) UIColor *borderColor;
-//The width of the ContainerView's stroked border. May be zero.
+/// The width of the ContainerView's stroked border. May be zero.
@property (nonatomic, assign) CGFloat borderWidth;
-//The radius of the ContainerView's rounded corners. May be zero.
+/// The radius of the ContainerView's rounded corners. May be zero.
@property (nonatomic, assign) CGFloat cornerRadius;
-//The fill color for the ContainerView's interior.
+/// The fill color for the ContainerView's interior.
@property (nonatomic, copy) UIColor *fillColor;
@@ -20,8 +20,8 @@
@class PSBaseTreeGraphView;
-// A SubtreeView draws nothing itself (unless showsSubtreeFrames is set to YES for the enclosingTreeGraph), but
-// provides a local coordinate frame and grouping mechanism for a graph subtree, and implements subtree layout.
+/// A SubtreeView draws nothing itself (unless showsSubtreeFrames is set to YES for the enclosingTreeGraph), but
+/// provides a local coordinate frame and grouping mechanism for a graph subtree, and implements subtree layout.
@interface PSBaseSubtreeView : UIView
@@ -42,20 +42,20 @@
// size; NO if we're sure its layout is up to date
}
-// Initializes a SubtreeView with the associated modelNode. This is SubtreeView's designated initializer.
+/// Initializes a SubtreeView with the associated modelNode. This is SubtreeView's designated initializer.
- initWithModelNode:( id <PSTreeGraphModelNode> )newModelNode;
-// The root of the model subtree that this SubtreeView represents.
+/// The root of the model subtree that this SubtreeView represents.
@property (nonatomic, retain) id <PSTreeGraphModelNode> modelNode;
-// The view that represents the modelNode. Is a subview of SubtreeView, and may itself have descendant views.
+/// The view that represents the modelNode. Is a subview of SubtreeView, and may itself have descendant views.
@property (nonatomic, assign) IBOutlet UIView *nodeView;
-// Link to the enclosing TreeGraph. (The getter for this is a convenience method that ascends the view tree until
-// it encounters a TreeGraph.)
+/// Link to the enclosing TreeGraph. (The getter for this is a convenience method that ascends
+/// the view tree until it encounters a TreeGraph.)
@property (nonatomic, readonly) PSBaseTreeGraphView *enclosingTreeGraph;
@@ -69,73 +69,73 @@
#pragma mark - Selection State
-// Whether the node is part of the TreeGraph's current selection. This can be a useful property to bind user
-// interface state to.
+/// Whether the node is part of the TreeGraph's current selection. This can be a useful property to bind user
+/// interface state to.
@property (nonatomic, readonly) BOOL nodeIsSelected;
#pragma mark - Layout
-//Returns YES if this subtree needs relayout.
+/// Returns YES if this subtree needs relayout.
- (BOOL) needsGraphLayout;
-//Marks this subtree as needing relayout.
+/// Marks this subtree as needing relayout.
- (void) setNeedsGraphLayout;
-//Recursively marks this subtree, and all of its descendants, as needing relayout.
+/// Recursively marks this subtree, and all of its descendants, as needing relayout.
- (void) recursiveSetNeedsGraphLayout;
-//Recursively performs graph layout, if this subtree is marked as needing it.
+/// Recursively performs graph layout, if this subtree is marked as needing it.
- (CGSize) layoutGraphIfNeeded;
-// Resizes this subtree's nodeView to the minimum size required to hold its content, and returns the nodeView's
-// new size. (This currently does nothing, and is just stubbed out for future use.)
+/// Resizes this subtree's nodeView to the minimum size required to hold its content, and returns the nodeView's
+/// new size. (This currently does nothing, and is just stubbed out for future use.)
- (CGSize) sizeNodeViewToFitContent;
-//Whether this subtree is currently shown as expanded. If NO, the node's children have been collapsed into it.
+/// Whether this subtree is currently shown as expanded. If NO, the node's children have been collapsed into it.
@property (nonatomic, assign, getter=isExpanded) BOOL expanded;
-// Toggles expansion of this subtree. This can be wired up as the action of a button or other user interface
-// control.
+/// Toggles expansion of this subtree. This can be wired up as the action of a button or other user interface
+/// control.
- (IBAction) toggleExpansion:(id)sender;
#pragma mark - Invalidation
-//Marks all BranchView instances in this subtree as needing display.
+/// Marks all BranchView instances in this subtree as needing display.
- (void) recursiveSetConnectorsViewsNeedDisplay;
-//Marks all SubtreeView debug borders as needing display.
+/// Marks all SubtreeView debug borders as needing display.
- (void) resursiveSetSubtreeBordersNeedDisplay;
#pragma mark - Node Hit-Testing
-// Returns the visible model node whose nodeView contains the given point "p", where "p" is specified in the
-// SubtreeView's interior (bounds) coordinate space. Returns nil if there is no node under the specified point.
-// When a subtree is collapsed, only its root nodeView is eligible for hit-testing.
+/// Returns the visible model node whose nodeView contains the given point "p", where "p" is specified in the
+/// SubtreeView's interior (bounds) coordinate space. Returns nil if there is no node under the specified point.
+/// When a subtree is collapsed, only its root nodeView is eligible for hit-testing.
- ( id <PSTreeGraphModelNode> ) modelNodeAtPoint:(CGPoint)p;
-// Returns the visible model node that is closest to the specified y coordinate, where "y" is specified in the
-// SubtreeView's interior (bounds) coordinate space.
+/// Returns the visible model node that is closest to the specified y coordinate, where "y" is specified in the
+/// SubtreeView's interior (bounds) coordinate space.
- ( id <PSTreeGraphModelNode> ) modelNodeClosestToY:(CGFloat)y;
#pragma mark - Debugging
-//Returns an indented multi-line NSString summary of the displayed tree. Provided as a debugging aid.
+/// Returns an indented multi-line NSString summary of the displayed tree. Provided as a debugging aid.
- (NSString *) treeSummaryWithDepth:(NSInteger)depth;
Oops, something went wrong.

0 comments on commit 0873d28

Please sign in to comment.