diff options
| author | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2024-02-12 01:07:05 +0900 |
|---|---|---|
| committer | git <svn-admin@ruby-lang.org> | 2024-02-11 16:08:14 +0000 |
| commit | bbccabe6d67c83ed81028e4c5ca9daaa4f6f7531 (patch) | |
| tree | 9034f5c5a9f609ee4e902fc0492bd82bdd2df550 /lib/optparse | |
| parent | a3ceb6916828b3d2e14b4d4bb4f8c78a0bc2ed95 (diff) | |
[ruby/optparse] [DOC] Add missing documents
https://github.com/ruby/optparse/commit/33956ce93f
Diffstat (limited to 'lib/optparse')
| -rw-r--r-- | lib/optparse/ac.rb | 16 | ||||
| -rw-r--r-- | lib/optparse/version.rb | 9 |
2 files changed, 25 insertions, 0 deletions
diff --git a/lib/optparse/ac.rb b/lib/optparse/ac.rb index 0953725e46..23fc740d10 100644 --- a/lib/optparse/ac.rb +++ b/lib/optparse/ac.rb @@ -1,7 +1,11 @@ # frozen_string_literal: false require_relative '../optparse' +# +# autoconf-like options. +# class OptionParser::AC < OptionParser + # :stopdoc: private def _check_ac_args(name, block) @@ -14,6 +18,7 @@ class OptionParser::AC < OptionParser end ARG_CONV = proc {|val| val.nil? ? true : val} + private_constant :ARG_CONV def _ac_arg_enable(prefix, name, help_string, block) _check_ac_args(name, block) @@ -29,16 +34,27 @@ class OptionParser::AC < OptionParser enable end + # :startdoc: + public + # Define <tt>--enable</tt> / <tt>--disable</tt> style option + # + # Appears as <tt>--enable-<i>name</i></tt> in help message. def ac_arg_enable(name, help_string, &block) _ac_arg_enable("enable", name, help_string, block) end + # Define <tt>--enable</tt> / <tt>--disable</tt> style option + # + # Appears as <tt>--disable-<i>name</i></tt> in help message. def ac_arg_disable(name, help_string, &block) _ac_arg_enable("disable", name, help_string, block) end + # Define <tt>--with</tt> / <tt>--without</tt> style option + # + # Appears as <tt>--with-<i>name</i></tt> in help message. def ac_arg_with(name, help_string, &block) _check_ac_args(name, block) diff --git a/lib/optparse/version.rb b/lib/optparse/version.rb index b869d8fe51..b5ed695146 100644 --- a/lib/optparse/version.rb +++ b/lib/optparse/version.rb @@ -2,6 +2,11 @@ # OptionParser internal utility class << OptionParser + # + # Shows version string in packages if Version is defined. + # + # +pkgs+:: package list + # def show_version(*pkgs) progname = ARGV.options.program_name result = false @@ -47,6 +52,8 @@ class << OptionParser result end + # :stopdoc: + def each_const(path, base = ::Object) path.split(/::|\//).inject(base) do |klass, name| raise NameError, path unless Module === klass @@ -68,4 +75,6 @@ class << OptionParser end end end + + # :startdoc: end |