class RDoc::Stats (Ruby 4.1 リファレンスマニュアル)

要約

RDoc のステータスを管理するクラスです。

例

require 'rdoc'
require 'tmpdir'

Dir.mktmpdir do |dir|
  path = File.join(dir, "foo.rb")
  File.write(path, <<~RUBY)
    class Foo
      # documented
      def a(x); end
      def b(y); end
    end
  RUBY

  rdoc = RDoc::RDoc.new
  rdoc.document(['--quiet', '-o', File.join(dir, 'out'), path])
  stats = rdoc.stats

  p stats.num_files
  # => 1
  p stats.files_so_far
  # => 1
  stats.summary
  p stats.fully_documented?
  # => false
end

特異メソッド

new(store, num_files, verbosity = 1) -> RDoc::Stats[permalink][rdoc][edit]

自身を初期化します。

[PARAM] store:: 解析結果を保持する RDoc::Store オブジェクトを指定します。
[PARAM] num_files:: 解析するファイルの数を整数で指定します。
[PARAM] verbosity:: 解析中に表示する進捗の詳しさを整数で指定します。0 は何も表示せず、1 は簡易な表示、2 以上は詳細な表示になります。

インスタンスメソッド

coverage_level -> IntegerRuby 3.0 から[permalink][rdoc][edit]

カバレッジレポートのレベルを返します。

-1 はカバレッジレポートを行わないことを、0 はクラス、モジュール、定数、属性、メソッドを対象にすることを、1 は 0 に加えてメソッドの引数も対象にすることを表します。

coverage_level=(level)Ruby 3.0 から[permalink][rdoc][edit]

カバレッジレポートのレベルを設定します。

[PARAM] level:: -1 以上の整数を指定します。false か nil を指定すると -1 になります。

files_so_far -> IntegerRuby 3.0 から[permalink][rdoc][edit]

これまでに解析したファイルの数を返します。

fully_documented? -> boolRuby 3.0 から[permalink][rdoc][edit]

全ての項目がドキュメント化されているかどうかを返します。

RDoc::Stats#summary で統計を計算した後の値が返されます。計算前は false を返します。

num_files -> Integer[permalink][rdoc][edit]

解析するファイルの数を返します。

report -> StringRuby 3.0 から[permalink][rdoc][edit]

ドキュメントが無い項目の報告を文字列で返します。

RDoc::Stats#coverage_level が 0 以上で、全ての項目にドキュメントがある場合は、そのことを伝えるメッセージを返します。

summary -> StringRuby 3.0 から[permalink][rdoc][edit]

統計の要約を文字列で返します。

クラス、モジュール、定数、属性、メソッドの数とそのうちドキュメントが無いものの数、ドキュメント化されている割合などを含みます。

要約

目次

特異メソッド

インスタンスメソッド