| Current Path : /usr/local/share/ri/1.8/system/OptionParser/Switch/ |
FreeBSD hs32.drive.ne.jp 9.1-RELEASE FreeBSD 9.1-RELEASE #1: Wed Jan 14 12:18:08 JST 2015 root@hs32.drive.ne.jp:/sys/amd64/compile/hs32 amd64 |
| Current File : //usr/local/share/ri/1.8/system/OptionParser/Switch/summarize-i.yaml |
--- !ruby/object:RI::MethodDescription
aliases: []
block_params: (indent + l)
comment:
- !ruby/struct:SM::Flow::P
body: Produces the summary text. Each line of the summary is yielded to the block (without newline).
- !ruby/object:SM::Flow::LIST
contents:
- !ruby/struct:SM::Flow::LI
label: "+sdone+:"
body: Already summarized short style options keyed hash.
- !ruby/struct:SM::Flow::LI
label: "+ldone+:"
body: Already summarized long style options keyed hash.
- !ruby/struct:SM::Flow::LI
label: "+width+:"
body: Width of left side (option part). In other words, the right side (description part) starts after <tt>width</tt> columns.
- !ruby/struct:SM::Flow::LI
label: "+max+:"
body: Maximum width of left side -> the options are filled within <tt>max</tt> columns.
- !ruby/struct:SM::Flow::LI
label: "+indent+:"
body: Prefix string indents all summarized lines.
type: :NOTE
full_name: OptionParser::Switch#summarize
is_singleton: false
name: summarize
params: (sdone = [], ldone = [], width = 1, max = width - 1, indent = "") {|indent + l| ...}
visibility: public