method

undoc_params

v2_1_10 - Show latest stable - 0 notes - Class: RDoc::Stats

1_8_6_287
1_8_7_72
1_8_7_330
1_9_1_378
1_9_2_180
1_9_3_125 (0)
1_9_3_392 (0)
2_1_10 (0)
2_2_9 (0)
2_4_6 (0)
2_5_5 (0)
2_6_3 (0)
What's this?

undoc_params(method) public

Determines which parameters in method were not documented. Returns a total parameter count and an Array of undocumented methods.

Show source

# File lib/rdoc/stats.rb, line 436
  def undoc_params method
    @formatter ||= RDoc::Markup::ToTtOnly.new

    params = method.param_list

    return 0, [] if params.empty?

    document = parse method.comment

    tts = document.accept @formatter

    undoc = params - tts

    [params.length, undoc]
  end

undoc_params

Related methods