method
class_document_constants
v2_1_10 -
Show latest stable
- Class:
RDoc::RI::Driver
class_document_constants(out, klass)public
Adds the constants from klass to the Document out.
# File lib/rdoc/ri/driver.rb, line 650
def class_document_constants out, klass # :nodoc:
return if klass.constants.empty?
out << RDoc::Markup::Heading.new(1, "Constants:")
out << RDoc::Markup::BlankLine.new
list = RDoc::Markup::List.new :NOTE
constants = klass.constants.sort_by { |constant| constant.name }
list.items.concat constants.map { |constant|
parts = constant.comment.parts if constant.comment
parts << RDoc::Markup::Paragraph.new('[not documented]') if
parts.empty?
RDoc::Markup::ListItem.new(constant.name, *parts)
}
out << list
out << RDoc::Markup::BlankLine.new
end Related methods
- Instance methods
- add_also_in
- add_class
- add_extends
- add_extension_modules
- add_extension_modules_multiple
- add_extension_modules_single
- add_from
- add_includes
- add_method
- add_method_documentation
- add_method_list
- ancestors_of
- class_cache
- class_document
- class_document_comment
- class_document_constants
- classes
- classes_and_includes_and_extends_for
- complete
- complete_klass
- complete_method
- display
- display_class
- display_method
- display_name
- display_names
- display_page
- display_page_list
- expand_class
- expand_name
- filter_methods
- find_methods
- find_pager_jruby
- find_store
- formatter
- in_path?
- interactive
- list_known_classes
- list_methods_matching
- load_method
- load_methods_matching
- lookup_method
- method_document
- method_type
- name_regexp
- page
- paging?
- parse_name
- render_class
- render_method
- render_method_arguments
- render_method_comment
- render_method_superclass
- run
- setup_pager
- start_server
- Class methods
- default_options
- dump
- new
- process_args
- run