Add documentation for the public changePathWith method

FolioReader · Sep 5, 2016 · 34228a6 · 34228a6
1 parent f0eec1f
commit 34228a6
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/Source/FolioReaderCenter.swift b/Source/FolioReaderCenter.swift
@@ -764,6 +764,13 @@ public class FolioReaderCenter: UIViewController, UICollectionViewDelegate, UICo
 
 	// MARK: Public page methods
 
+	/**
+	Changes the current page of the reader.
+
+	- parameter page: The target page index. Note: The page index starts at 1 (and not 0).
+	- parameter animated: En-/Disables the animation of the page change.
+	- parameter completion: A Closure which is called if the page change is completed.
+	*/
 	public func changePageWith(page page: Int, animated: Bool = false, completion: (() -> Void)? = nil) {
 		if page > 0 && page-1 < totalPages {
 			let indexPath = NSIndexPath(forRow: page-1, inSection: 0)