method
report_class_module
v1_9_3_125 -
Show latest stable
- Class:
RDoc::Stats
report_class_module(cm)public
Returns a report on undocumented items in ClassModule cm
# File lib/rdoc/stats.rb, line 272
def report_class_module cm
return if cm.fully_documented? and @coverage_level.zero?
report = []
if cm.in_files.empty? then
report << "# #{cm.definition} is referenced but empty."
report << '#'
report << '# It probably came from another project. ' "I'm sorry I'm holding it against you."
report << nil
return report
elsif cm.documented? then
documented = true
report << "#{cm.definition} # is documented"
else
report << '# in files:'
cm.in_files.each do |file|
report << "# #{file.full_name}"
end
report << nil
report << "#{cm.definition}"
end
body = yield.flatten # HACK remove #flatten
return if body.empty? and documented
report << nil << body unless body.empty?
report << 'end'
report << nil
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