documentation

PXParallaxViewController/PXParallaxViewController.h

@@ -27,11 +27,29 @@
 
 
 @interface PXParallaxViewController : UIViewController <UIScrollViewDelegate>
+/**
+ * The scrollview that contains the content
+ */
 @property (nonatomic, readonly) UIScrollView *contentScrollView;
+
+/**
+ * The scrollview that contains the parallax View
+ */
 @property (nonatomic, readonly) UIScrollView *parallaxScrollView;
 
+/**
+ * The view to be shown with the parallax effect
+ */
 @property (nonatomic, strong) UIView *parallaxView;
+
+/**
+ * The content view that obscures the parallax view
+ */
 @property (nonatomic, strong) UIView *contentView;
+
+/**
+ * The visible height of the parallax view at rest
+ */
 @property (nonatomic, assign) CGFloat parallaxHeight;
 
 - (id)initWithContentView:(UIView *)contentView andParallaxView:(UIView *)parallaxView;

README.md

@@ -7,4 +7,9 @@ the content scrollview use delegate methods to update the offsets but will forwa
 delegate methods is you set its delegate, currently this done a bit clumsily, I may revise
 this later using a bit of runtime manipulation.
 
+TODO:
+-----
+- There are some constants borrowed from RBParallaxTableViewController that might better 
+be computed properties for this kind of implementation.
+
 [1]: https://github.com/Rheeseyb/RBParallaxTableViewController