aboutsummaryrefslogtreecommitdiffstats
path: root/Source/SPFavoriteNode.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/SPFavoriteNode.h')
-rw-r--r--Source/SPFavoriteNode.h19
1 files changed, 19 insertions, 0 deletions
diff --git a/Source/SPFavoriteNode.h b/Source/SPFavoriteNode.h
index 289958f7..0493ae70 100644
--- a/Source/SPFavoriteNode.h
+++ b/Source/SPFavoriteNode.h
@@ -23,6 +23,14 @@
//
// More info at <http://code.google.com/p/sequel-pro/>
+/**
+ * @class SPFavoriteNode SPFavoriteNode.h
+ *
+ * @author Stuart Connolly http://stuconnolly.com/
+ *
+ * This class is designed to be a simple wrapper around a connection favorite to allow us to easily represent
+ * them in a tree structure for use in an outline view.
+ */
@interface SPFavoriteNode : NSObject
{
BOOL isGroup;
@@ -30,8 +38,19 @@
NSMutableArray *children;
}
+/**
+ * @property isGroup Indicates whether this node is a group item
+ */
@property (readwrite, assign) BOOL isGroup;
+
+/**
+ * @property favorite The actual favorite dictionary
+ */
@property (readwrite, retain) NSDictionary *favorite;
+
+/**
+ * @property children This node's children
+ */
@property (readwrite, retain) NSMutableArray *children;
@end