]> granicus.if.org Git - onig/commitdiff
update doc/CALLOUTS.BUILTIN
authorK.Kosako <kosako@sofnec.co.jp>
Thu, 15 Mar 2018 01:26:38 +0000 (10:26 +0900)
committerK.Kosako <kosako@sofnec.co.jp>
Thu, 15 Mar 2018 01:26:38 +0000 (10:26 +0900)
doc/CALLOUTS.BUILTIN
doc/CALLOUTS.BUILTIN.ja

index cefbc6a29853be55ae8db92d791fa8dad0270b8e..b173da99a382124ad6752e4c8b97e52f239a6f8f 100644 (file)
@@ -1,4 +1,4 @@
-CALLOUTS.BUILTIN               2018/03/14
+CALLOUTS.BUILTIN               2018/03/15
 
 
 * FAIL
@@ -16,20 +16,14 @@ CALLOUTS.BUILTIN               2018/03/14
   Continue Search process.
 
 
-* ABORT
-
-  (*ABORT)
-
-  Terminate Search/Match process.
-  Return value is ONIG_ABORT.
-
-
 * ERROR
 
   (*ERROR{n::LONG})
 
   Terminate Search/Match process.
+
   Return value is the argument 'n'. (The value must be negative.)
+  'n' is an optional argument. (default value is ONIG_ABORT)
 
 
 * MAX
@@ -48,7 +42,7 @@ CALLOUTS.BUILTIN               2018/03/14
 
   Counter.
   Depends on 'c' argument, the slot 0 value changes.
-  Default 'c' value is '>'.
+  'c' is an optional argument, deefault value is '>'.
 
   [callout data]
   slot 0: '>': progress count, '<': retraction count, 'X': success count
@@ -58,7 +52,7 @@ CALLOUTS.BUILTIN               2018/03/14
   (* success count = progress count - retraction count)
 
   ** If option ONIG_OPTION_FIND_LONGEST or ONIG_OPTION_FIND_NOT_EMPTY is used,
-     COUNT and TOTAL_COUNT are not accurate.
+     counts are not accurate.
 
 
 * TOTAL_COUNT
@@ -67,13 +61,16 @@ CALLOUTS.BUILTIN               2018/03/14
 
   It's the almost same as COUNT.
   But the counts are integrated in a search process.
-  Default 'c' value is '>'.
+  'c' is an optional argument, deefault value is '>'.
 
   [callout data]
   slot 0: '>': progress count, '<': retraction count, 'X': success count
   slot 1: progress count
   slot 2: retraction count
 
+  ** If option ONIG_OPTION_FIND_LONGEST or ONIG_OPTION_FIND_NOT_EMPTY is used,
+     counts are not accurate.
+
 
 * CMP
 
index 239fce062ede100ad3fe1ac64b82e4abe772051d..8ba2ff80b4118d2148ebb466cf45a5189cdf17cc 100644 (file)
@@ -1,4 +1,4 @@
-CALLOUTS.BUILTIN.ja               2018/03/14
+CALLOUTS.BUILTIN.ja               2018/03/15
 
 
 * FAIL
@@ -16,20 +16,13 @@ CALLOUTS.BUILTIN.ja               2018/03/14
   検索は継続する
 
 
-* ABORT
-
-  (*ABORT)
-
-  検索/照合を中止する
-  戻り値: ONIG_ABORT
-
-
 * ERROR
 
   (*ERROR{n::LONG})
 
   検索/照合を中止する
   戻り値は引数'n'の値。(負の値でなければならない)
+  'n'はオプション引数で、デフォルト値はONIG_ABORT
 
 
 * MAX
@@ -48,7 +41,7 @@ CALLOUTS.BUILTIN.ja               2018/03/14
 
   カウンタ
   'c'引数の値によって、slot 0の値が変化する
-  デフォルトの'c'の値は '>'
+  'c'はオプション引数で、デフォルト値は'>'
 
   [callout data]
   slot 0: '>': 前進回数, '<': 後退回数, 'X': 成功回数
@@ -58,7 +51,7 @@ CALLOUTS.BUILTIN.ja               2018/03/14
   (* 成功回数 = 前進回数 - 後退回数)
 
   ** ONIG_OPTION_FIND_LONGEST または ONIG_OPTION_FIND_NOT_EMPTY が使用されると
-     COUNT と TOTAL_COUNT は正確な動作ができなくなる
+     正確な動作ができなくなる
 
 
 * TOTAL_COUNT
@@ -67,13 +60,16 @@ CALLOUTS.BUILTIN.ja               2018/03/14
 
   これはCOUNTとほとんど同じ
   しかし、カウントが検索過程で積算される
-  デフォルトの'c'の値は '>'
+  'c'はオプション引数で、デフォルト値は'>'
 
   [callout data]
   slot 0: '>': 前進回数, '<': 後退回数, 'X': 成功回数
   slot 1: 前進回数
   slot 2: 後退回数
 
+  ** ONIG_OPTION_FIND_LONGEST または ONIG_OPTION_FIND_NOT_EMPTY が使用されると
+     正確な動作ができなくなる
+
 
 * CMP