Class | YARD::CLI::Stats |
In: |
lib/yard/cli/stats.rb
|
Parent: | Yardoc |
@since 0.6.0
STATS_ORDER | = | [:files, :modules, :classes, :constants, :methods] |
Maintains the order in which stats_for_ statistics methods should
be printed.
@see print_statistics |
parse | [RW] | @return [Boolean] whether to parse and load registry |
@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}.