update documentation

detroit-labs · Apr 30, 2015 · 525697d · 525697d
1 parent a7b4fee
commit 525697d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/DLRUIKit/source/UINavigationController+DLR.h b/DLRUIKit/source/UINavigationController+DLR.h
@@ -10,7 +10,9 @@
 
 @interface UINavigationController (DLR)
 
-/** Returns true if the passed view controller is the first view controller in the stack of view controllers. */
+/** Returns true if the passed view controller is the first view controller in the
+ stack of view controllers.  This can be helpful in determining if the
+ view controller needed to be popped or dismissed. */
 - (BOOL)dlr_isFirstViewController:(UIViewController *)viewController;
 
 @end
diff --git a/DLRUIKit/source/UIViewController+DLRNavigationController.h b/DLRUIKit/source/UIViewController+DLRNavigationController.h
@@ -10,7 +10,8 @@
 
 @interface UIViewController (DLRNavigationController)
 
-/** Returns a new navigation controller instance with this view controller as the root view controller. */
+/** Returns a new navigation controller instance with this view controller as the
+ root view controller. */
 - (UINavigationController *)dlr_embedInsideNavigationController;
 
 @end
diff --git a/README.md b/README.md
@@ -177,14 +177,15 @@ layoutConstraint.constant = -10;
 
 ```objc
 /** Returns true if the passed view controller is the first view controller in the
-    stack of view controllers. */
+ stack of view controllers.  This can be helpful in determining if the
+ view controller needed to be popped or dismissed. */
 - (BOOL)dlr_isFirstViewController:(UIViewController *)viewController;
 ```
 
 ### UIViewController+DLRNavigationController Category Examples
 
 ```objc
 /** Returns a new navigation controller instance with this view controller as the
-    root view controller. */
+ root view controller. */
 - (UINavigationController *)dlr_embedInsideNavigationController;
 ```