method
report_methods
v2_2_9 -
Show latest stable
- Class:
RDoc::Stats
report_methods(cm)public
Returns a report on undocumented methods in ClassModule cm
# File lib/rdoc/stats.rb, line 350
def report_methods cm
return if cm.method_list.empty?
report = []
cm.each_method do |method|
next if method.documented? and @coverage_level.zero?
if @coverage_level > 0 then
params, undoc = undoc_params method
@num_params += params
unless undoc.empty? then
@undoc_params += undoc.length
undoc = undoc.map do |param| "+#{param}+" end
param_report = " # #{undoc.join ', '} is not documented\n"
end
end
next if method.documented? and not param_report
line = method.line ? ":#{method.line}" : nil
scope = method.singleton ? 'self.' : nil
report << " # in file #{method.file.full_name}#{line}\n"
report << param_report if param_report
report << " def #{scope}#{method.name}#{method.params}; end\n"
report << "\n"
end
report
end Related methods
- Instance methods
- add_alias
- add_attribute
- add_class
- add_constant
- add_file
- add_method
- add_module
- begin_adding
- calculate
- coverage_level=
- doc_stats
- done_adding
- fully_documented?
- great_job
- percent_doc
- report
- report_attributes
- report_class_module
- report_constants
- report_methods
- summary
- undoc_params
- Class methods
- new