Merge pull request #11 from rurema/update-generated-documents

Update generated documents

Author: github-actions[bot]

db/db-3.0/method/-option-parser/i.default_argv.optparse

@@ -1,7 +1,7 @@
 names=default_argv
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:1133
+source_location=refm/api/src/optparse/OptionParser:1135
 
 --- default_argv    -> [String]
 

db/db-3.0/method/-option-parser/i.default_argv=3d.optparse

@@ -1,7 +1,7 @@
 names=default_argv=
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:1148
+source_location=refm/api/src/optparse/OptionParser:1150
 
 --- default_argv=(argv)
 

db/db-3.0/method/-option-parser/i.environment.optparse

@@ -1,7 +1,7 @@
 names=environment
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:1109
+source_location=refm/api/src/optparse/OptionParser:1111
 
 --- environment(env)    -> [String]
 

db/db-3.0/method/-option-parser/i.getopts.optparse

@@ -1,7 +1,7 @@
 names=getopts
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:1174
+source_location=refm/api/src/optparse/OptionParser:1176
 
 --- getopts(argv, *opts)   -> Hash
 --- getopts(*opts)         -> Hash

db/db-3.0/method/-option-parser/i.load.optparse

@@ -1,7 +1,7 @@
 names=load
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:1083
+source_location=refm/api/src/optparse/OptionParser:1085
 
 --- load(filename = nil)     -> bool
 

db/db-3.0/method/-option-parser/i.on.optparse

@@ -28,22 +28,24 @@ source_location=refm/api/src/optparse/OptionParser:561
 //}
              となります。コマンドラインにオプションが存在した場合 true を引数と
              してブロックを評価します。
-             ショートオプションが引数をとる場合は、
+             ショートオプションが引数をとる場合は、以下のようになります。
 //emlist{
-  on("-x MANDATORY"){|val| ...}
+  on("-x MANDATORY"){|val| ...} # " MANDATORY" の部分は任意の文字列で構いません
+  on("-xSTRING"){|val| ...} # スペース無しで任意の文字列を入れても同様
 //}
-             となります。"MANDATORY" の部分は任意の文字列で構いません。
              オプションの引数が必須でない場合は [ ] をつけて、
 //emlist{
   on("-x [OPTIONAL]"){|val| ...}
 //}
              となります。
 
-@param long ロングオプションを表す文字列を指定します。ショートオプションの時と同様に、
+@param long ロングオプションを表す文字列を指定します。ショートオプションの時とほぼ同様に、
 //emlist{
-  on("--long"){|boolean| ...}
-  on("--long MANDATORY"){|val| ...}
-  on("--long [OPTIONAL]"){|val| ...}
+  on("--long"){|boolean| ...}  # オプションが引数をとらない場合。boolean には true が渡されます。
+  on("--long MANDATORY"){|val| ...} # オプションが引数をとる場合。" MANDATORY" の部分は任意の文字列で構いません
+  on("--long=MANDATORY"){|val| ...} # 空白のかわりに = を使って指定することもできます
+  # on("--longSTRING"){|val| ...} # ロングオプションでは、ショートオプションの場合と違って空白が必ず必要です。このようにすると --longSTRING という名前の引数をとらないオプションになります。
+  on("--long [OPTIONAL]"){|val| ...}  # 引数が必須でないオプション
 //}
             と指定できます。
 

db/db-3.0/method/-option-parser/i.on_head.optparse

@@ -1,7 +1,7 @@
 names=on_head
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:741
+source_location=refm/api/src/optparse/OptionParser:743
 
 --- on_head(*arg, &block) -> self
 

db/db-3.0/method/-option-parser/i.on_tail.optparse

@@ -1,7 +1,7 @@
 names=on_tail
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:768
+source_location=refm/api/src/optparse/OptionParser:770
 
 --- on_tail(*arg, &block) -> self
 

db/db-3.0/method/-option-parser/i.order.optparse

@@ -1,7 +1,7 @@
 names=order
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:813
+source_location=refm/api/src/optparse/OptionParser:815
 
 --- order(argv, into: nil)            -> [String]
 --- order(argv, into: nil){|s| ...}   -> [String]

db/db-3.0/method/-option-parser/i.order=21.optparse

@@ -1,7 +1,7 @@
 names=order!
 visibility=public
 kind=defined
-source_location=refm/api/src/optparse/OptionParser:865
+source_location=refm/api/src/optparse/OptionParser:867
 
 --- order!(argv = self.default_argv, into: nil)             -> [String]
 --- order!(argv = self.default_argv, into: nil) {|s| ...}   -> [String]