add doc for the new browse API

dethi · dethi · commit 73782b8fbeec · 2015-06-10T14:22:12.000+02:00
diff --git a/Source/Index.swift b/Source/Index.swift
@@ -380,7 +380,6 @@ public class Index {
                 if queryURL != "" {
                     requestPath += "&"
                 }
-                
                 requestPath += "cursor=\(cursor.urlEncode())"
             }
             
@@ -401,6 +400,11 @@ public class Index {
         }
     }
     
+    /// Browse all index content.
+    /// At the end of the block handler, call the method `next()` of the iterator object to get the next page.
+    /// The parameter `end` is set to true when all the index was browsed.
+    ///
+    /// :param: query The query parameters for the browse.
     public func browse(query: Query, block: BrowseIteratorHandler) {
         let iterator = BrowseIterator(index: self, query: query, block: block)
         iterator.next() // first call

Original file line number	Diff line number	Diff line change
`@@ -380,7 +380,6 @@ public class Index {`
`380`	`380`	`if queryURL != "" {`
`381`	`381`	`requestPath += "&"`
`382`	`382`	`}`
`383`		`-`
`384`	`383`	`requestPath += "cursor=\(cursor.urlEncode())"`
`385`	`384`	`}`
`386`	`385`
`@@ -401,6 +400,11 @@ public class Index {`
`401`	`400`	`}`
`402`	`401`	`}`
`403`	`402`
	`403`	`+ /// Browse all index content.`
	`404`	+ /// At the end of the block handler, call the method `next()` of the iterator object to get the next page.
	`405`	+ /// The parameter `end` is set to true when all the index was browsed.
	`406`	`+ ///`
	`407`	`+ /// :param: query The query parameters for the browse.`
`404`	`408`	`public func browse(query: Query, block: BrowseIteratorHandler) {`
`405`	`409`	`let iterator = BrowseIterator(index: self, query: query, block: block)`
`406`	`410`	`iterator.next() // first call`