Permalink
Browse files

[DOCUMENTATION] Added documentation for MBCoverFlowImageLoadOperation.

                Slight modifications to docs for other classes.
  • Loading branch information...
1 parent baf1fe7 commit 15ac977addb39c82d4fe03486c0c95bb7dbdafe6 @mattball committed Mar 29, 2009
@@ -9,14 +9,46 @@
#import <Cocoa/Cocoa.h>
#import <QuartzCore/QuartzCore.h>
+/**
+ * @class MBCoverFlowImageLoadOperation
+ *
+ * @brief An NSOperation which loads the image for a Cover Flow layer.
+ */
@interface MBCoverFlowImageLoadOperation : NSOperation {
CALayer *_layer;
NSString *_imageKeyPath;
}
-@property (nonatomic, retain) CALayer *layer;
-@property (nonatomic, copy) NSString *imageKeyPath;
+/**
+ * @name Initialization
+ */
+/**
+ * @brief Returns an initialized MBCoverFlowImageLoadOperation object
+ * for the specified layer with the specified key path.
+ *
+ * @param layer The operation's \c layer property.
+ * @param imageKeyPath The operation's \c imageKeyPath property.
+ *
+ * @return The initialized MBCoverFlowImageLoadOperation object.
+ */
- (id)initWithLayer:(CALayer *)layer imageKeyPath:(NSString *)imageKeyPath;
+/**
+ * @name Relationships
+ */
+
+/**
+ * @brief The layer whose image should be loaded.
+ */
+@property (nonatomic, retain) CALayer *layer;
+
+/**
+ * @brief The key path which, when applied to the layer's
+ * \c representedObject, will return the image for the layer.
+ * @details If this property is \c nil, the layer's \c representedObject
+ * will be interpreted as the image.
+ */
+@property (nonatomic, copy) NSString *imageKeyPath;
+
@end
@@ -27,6 +27,8 @@
#import <Cocoa/Cocoa.h>
/**
+ * @class MBCoverFlowScroller
+ *
* @brief A scroller which has an appearance appropriate for a
* CoverFlow-style environment.
*/
View
@@ -29,6 +29,12 @@
@class MBCoverFlowScroller;
+/**
+ * @class MBCoverFlowView
+ *
+ * @brief An NSView subclass which displays a collection of
+ * items using the Cover Flow style.
+ */
@interface MBCoverFlowView : NSView {
NSInteger _selectionIndex;
@@ -59,16 +59,16 @@
080E96DDFE201D6D7F000001 /* Classes */ = {
isa = PBXGroup;
children = (
- C9D173580F6B38CD0097827F /* MBCoverFlowView.h */,
- C9D173590F6B38CD0097827F /* MBCoverFlowView.m */,
C9D178210F6F97D60097827F /* MBCoverFlowViewController.h */,
C9D178220F6F97D60097827F /* MBCoverFlowViewController.m */,
- C9E9ACB40F78B188004DDC0A /* NSImage+MBCoverFlowAdditions.h */,
- C9E9ACB50F78B188004DDC0A /* NSImage+MBCoverFlowAdditions.m */,
+ C9D173580F6B38CD0097827F /* MBCoverFlowView.h */,
+ C9D173590F6B38CD0097827F /* MBCoverFlowView.m */,
C91E73FA0F79F75C00FD319E /* MBCoverFlowScroller.h */,
C91E73FB0F79F75C00FD319E /* MBCoverFlowScroller.m */,
C91E7EE50F7F442F00FD319E /* MBCoverFlowImageLoadOperation.h */,
C91E7EE60F7F442F00FD319E /* MBCoverFlowImageLoadOperation.m */,
+ C9E9ACB40F78B188004DDC0A /* NSImage+MBCoverFlowAdditions.h */,
+ C9E9ACB50F78B188004DDC0A /* NSImage+MBCoverFlowAdditions.m */,
);
name = Classes;
sourceTree = "<group>";
@@ -26,7 +26,11 @@
#import <Cocoa/Cocoa.h>
-
+/**
+ * @category NSImage(MBCoverFlowAdditions)
+ *
+ * @brief Additions to NSImage which are used by MBCoverFlowView.
+ */
@interface NSImage (MBCoverFlowAdditions)
/**

0 comments on commit 15ac977

Please sign in to comment.