Skip to content

Commit 06d625e

Browse files
committed
Update doc
1 parent f2d7ca7 commit 06d625e

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

Source/AMWaveTransition.h

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,41 @@
33
// AMWaveTransition
44
//
55
// Created by Andrea on 11/04/14.
6-
// Copyright (c) 2014 Fancy Pixel. All rights reserved.
6+
// Copyright (c) 2015 Fancy Pixel. All rights reserved.
77
//
88

99
@import UIKit;
1010

11+
/**-----------------------------------------------------------------------------
12+
* @name AMWaveTransitioning
13+
* -----------------------------------------------------------------------------
14+
*/
1115
@protocol AMWaveTransitioning <NSObject>
1216

17+
/** Visible cells
18+
*
19+
* Returns the cells that need to be animated.
20+
*
21+
* @return An array of UIViews
22+
*/
1323
- (NSArray*)visibleCells;
1424

1525
@end
1626

27+
/** @enum AMWaveTransitionType
28+
*
29+
* Enum that specifies the type of animation
30+
*/
1731
typedef NS_ENUM(NSInteger, AMWaveTransitionType) {
1832
AMWaveTransitionTypeSubtle,
1933
AMWaveTransitionTypeNervous,
2034
AMWaveTransitionTypeBounce
2135
};
2236

37+
/** @enum AMWaveInteractiveTransitionType
38+
*
39+
* Enum that specifies the transition type
40+
*/
2341
typedef NS_ENUM(NSInteger, AMWaveInteractiveTransitionType) {
2442
AMWaveTransitionEdgePan,
2543
AMWaveTransitionFullScreenPan,

Source/AMWaveViewController.h

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// Demo
44
//
55
// Created by Andrea Mazzini on 16/04/14.
6-
// Copyright (c) 2014 Fancy Pixel. All rights reserved.
6+
// Copyright (c) 2015 Fancy Pixel. All rights reserved.
77
//
88

99
#import "AMWaveTransition.h"
@@ -12,6 +12,15 @@
1212

1313
@interface AMWaveViewController : UIViewController <UINavigationControllerDelegate, AMWaveTransitioning>
1414

15+
/**-----------------------------------------------------------------------------
16+
* @name AMWaveViewController
17+
* -----------------------------------------------------------------------------
18+
*/
19+
20+
/** Wave transition
21+
*
22+
* The AMWaveTranstion used by the controller
23+
*/
1524
@property (strong, nonatomic) IBOutlet AMWaveTransition *interactive;
1625

1726
@end

0 commit comments

Comments
 (0)