method
report
v2_2_9 -
Show latest stable
- Class:
RDoc::Stats
report()public
Returns a report on which items are not documented
# File lib/rdoc/stats.rb, line 217
def report
if @coverage_level > 0 then
extend RDoc::Text
end
if @coverage_level.zero? then
calculate
return great_job if @num_items == @doc_items
end
ucm = @store.unique_classes_and_modules
report = RDoc::Markup::Document.new
report << RDoc::Markup::Paragraph.new('The following items are not documented:')
report << RDoc::Markup::BlankLine.new
ucm.sort.each do |cm|
body = report_class_module(cm) {
[
report_constants(cm),
report_attributes(cm),
report_methods(cm),
].compact
}
report << body if body
end
if @coverage_level > 0 then
calculate
return great_job if @num_items == @doc_items
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