Imported Upstream version 6.1.0upstream/6.1.0

1 files changed, 26 insertions, 1 deletions

diff --git a/doc/API b/doc/API
index 9904a06..8e824f5 100644
--- a/doc/API
+++ b/doc/API
@@ -1,4 +1,4 @@
-Oniguruma API  Version 6.0.0  2016/05/06
+Oniguruma API  Version 6.1.0  2016/08/22
 
 #include <oniguruma.h>
 
@@ -256,6 +256,27 @@ Oniguruma API  Version 6.0.0  2016/05/06
     ONIG_OPTION_POSIX_REGION region argument is regmatch_t[] type of POSIX API.
 
 
+# int onig_scan(regex_t* reg, const UChar* str, const UChar* end,
+                OnigRegion* region, OnigOptionType option,
+                int (*scan_callback)(int, int, OnigRegion*, void*),
+                void* callback_arg)
+
+  Scan string and callback with matching region.
+
+  normal return: number of matching times
+  error:         error code
+  interruption:  return value of callback function (!= 0)
+
+  arguments
+  1 reg:    regex object
+  2 str:    target string
+  3 end:    terminate address of target string
+  4 region: address for return group match range info (NULL is allowed)
+  5 option: search time option
+  6 scan_callback: callback function (defined by user)
+  7 callback_arg:  optional argument passed to callback
+
+
 # OnigRegion* onig_region_new(void)
 
   Create a region.
@@ -601,6 +622,10 @@ Oniguruma API  Version 6.0.0  2016/05/06
   2 ranges:  property code point ranges
              (first element is number of ranges.)
 
+    [num-of-ranges, 1st-range-start, 1st-range-end, 2nd-range-start... ]
+
+    * Don't destroy the ranges after having called this function.
+
   normal return: ONIG_NORMAL