method
report
v1_9_3_392 -
Show latest stable
- Class:
RDoc::Stats
report()public
Returns a report on which items are not documented
# File lib/rdoc/stats.rb, line 212
def report
if @coverage_level > 0 then
require 'rdoc/markup/to_tt_only'
require 'rdoc/generator/markup'
require 'rdoc/text'
extend RDoc::Text
end
report = []
if @coverage_level.zero? then
calculate
return great_job if @num_items == @doc_items
end
ucm = RDoc::TopLevel.unique_classes_and_modules
ucm.sort.each do |cm|
report << report_class_module(cm) {
[
report_constants(cm),
report_attributes(cm),
report_methods(cm),
].compact
}
end
if @coverage_level > 0 then
calculate
return great_job if @num_items == @doc_items
end
report.unshift nil
report.unshift 'The following items are not documented:'
report.join "\n"
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