Home » Ruby-3.1.7 » rdoc » Index (V) » RDoc » Stats » Verbose ▲

123456789_123456789_123456789_123456789_123456789_

Class: RDoc::Stats::Verbose

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Normal`, `Quiet`
Instance Chain: self, `Normal`, `Quiet`
Inherits:	RDoc::Stats::Normal Object RDoc::Stats::Quiet RDoc::Stats::Normal RDoc::Stats::Verbose
Defined in:	lib/rdoc/stats/verbose.rb

Overview

::RDoc::Stats printer that prints everything documented, including the documented status

Class Method Summary

`Quiet` - Inherited

.new	Creates a new `Quiet` that will print nothing.

Instance Method Summary

#nodoc(co)

Returns a marker for ::RDoc::CodeObject co being undocumented.
#print_alias(as) Internal use only
#print_attribute(attribute) Internal use only
#print_class(klass) Internal use only
#print_constant(constant) Internal use only
#print_file(files_so_far, file) Internal use only
#print_method(method) Internal use only
#print_module(mod) Internal use only

`Normal` - Inherited

#print_file	Prints a file with a progress bar.
#begin_adding, #done_adding

`Quiet` - Inherited

#begin_adding	Prints a message at the beginning of parsing.
#done_adding	Prints when `::RDoc::RDoc` is done.
#print_alias	Prints when an alias is added.
#print_attribute	Prints when an attribute is added.
#print_class	Prints when a class is added.
#print_constant	Prints when a constant is added.
#print_file	Prints when a file is added.
#print_method	Prints when a method is added.
#print_module	Prints when a module is added.

Constructor Details

This class inherits a constructor from RDoc::Stats::Quiet

Instance Method Details

#nodoc(co)

Returns a marker for ::RDoc::CodeObject co being undocumented

[ GitHub ]

# File 'lib/rdoc/stats/verbose.rb', line 11


def nodoc co
  " (undocumented)" unless co.documented?
end

#print_alias(as)

This method is for internal use only.

[ GitHub ]

# File 'lib/rdoc/stats/verbose.rb', line 15


def print_alias as # :nodoc:
  puts "    alias #{as.new_name} #{as.old_name}#{nodoc as}"
end

#print_attribute(attribute)

This method is for internal use only.

[ GitHub ]

# File 'lib/rdoc/stats/verbose.rb', line 19


def print_attribute attribute # :nodoc:
  puts "    #{attribute.definition} #{attribute.name}#{nodoc attribute}"
end

#print_class(klass)

This method is for internal use only.

[ GitHub ]

# File 'lib/rdoc/stats/verbose.rb', line 23


def print_class(klass) # :nodoc:
  puts "  class #{klass.full_name}#{nodoc klass}"
end

#print_constant(constant)

This method is for internal use only.

[ GitHub ]

# File 'lib/rdoc/stats/verbose.rb', line 27


def print_constant(constant) # :nodoc:
  puts "    #{constant.name}#{nodoc constant}"
end

#print_file(files_so_far, file)

This method is for internal use only.

[ GitHub ]

# File 'lib/rdoc/stats/verbose.rb', line 31


def print_file(files_so_far, file) # :nodoc:
  super
  puts
end

#print_method(method)

This method is for internal use only.

[ GitHub ]

# File 'lib/rdoc/stats/verbose.rb', line 36


def print_method(method) # :nodoc:
  puts "    #{method.singleton ? '::' : '#'}#{method.name}#{nodoc method}"
end

#print_module(mod)

This method is for internal use only.

[ GitHub ]

# File 'lib/rdoc/stats/verbose.rb', line 40


def print_module(mod) # :nodoc:
  puts "  module #{mod.full_name}#{nodoc mod}"
end