Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > optparseライブラリ > OptionParserクラス > summarize

instance method OptionParser#summarize

summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) -> ()[permalink][rdoc]

summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) {|line| ... } -> ()

サマリを指定された to へと加えていきます。

ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。 この場合、ブロックの中で明示的に to へと加えていかない限り、 to にサマリが加えられることはありません。

[PARAM] to:

サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。

[PARAM] width:

サマリの幅を整数で指定します。

[PARAM] max:

サマリの最大幅を整数で指定します。

[PARAM] indent:

サマリのインデントを文字列で指定します。