Class YARD::CLI::Stats
In: lib/yard/cli/stats.rb
Parent: Yardoc

@since 0.6.0

Methods

Included Modules

Templates::Helpers::BaseHelper

Constants

STATS_ORDER = [:files, :modules, :classes, :constants, :methods]   Maintains the order in which stats_for_ statistics methods should be printed.

@see print_statistics

Attributes

parse  [RW]  @return [Boolean] whether to parse and load registry

Public Class methods

@param [Boolean] parse whether to parse and load registry (see {parse})

Public Instance methods

@return [Array<CodeObjects::Base>] all the parsed objects in the registry,

  removing any objects that are not visible (private, protected) depending
  on the arguments passed to the command.

Prints a statistic to standard out. This method is optimized for getting Integer values, though it allows any data to be printed.

@param [String] name the statistic name @param [Integer, String] data the numeric (or any) data representing

  the statistic. If +data+ is an Integer, it should represent the
  total objects of a type.

@param [Integer, nil] undoc number of undocumented objects for the type @return [void]

Prints statistics for different object types

To add statistics for a specific type, add a method +stats_for_TYPE+ to this class that calls {output}.

Prints list of undocumented objects

Runs the commandline utility, parsing arguments and generating output if set.

@param [Array<String>] args the list of arguments @return [void]

Statistics for classes

Statistics for constants

Statistics for files

Statistics for methods

Statistics for modules

[Validate]