Module: Bri::Templates

Defined in:

lib/bri/templates.rb

Defined Under Namespace

Modules: Helpers

Constant Summary

RULE_CHARACTER =

'-'.freeze

MULTIPLE_CHOICES =

"<%= Bri::Templates::Helpers.hrule( \"Multiple choices:\" ) %>\n\n<%= qualified_methods.sort.join(\"\\n\") %>\n\n\n"

CLASS_DESCRIPTION =

"<%= hrule( type + \": \" + name ) %>\n<%= print_origin( origin ) %>\n\n<% if description_paragraphs.empty? %>\n  (no description...)\n<% else %>\n<%= description_paragraphs.join(\"\\n\" ) %>\n<% end %>\n\n<%= hrule %>\n\n<% if !includes.empty? %>\n<%= section_header( \"Includes:\" ) %>\n<%= Bri::Renderer.wrap_list( includes.sort ) %>\n\n\n<% end %>\n<% if !extends.empty? %>\n<%= section_header( \"Extends:\" ) %>\n<%= Bri::Renderer.wrap_list( extends.sort ) %>\n\n\n<% end %>\n<% if !constants.empty? %>\n<%= section_header( \"Constants:\" ) %>\n<%= Bri::Renderer.wrap_list( constants.sort ) %>\n\n\n<% end %>\n<% if !class_methods.empty? %>\n<%= section_header( \"Class methods:\" ) %>\n<%= Bri::Renderer.wrap_list( class_methods.sort ) %>\n\n\n<% end %>\n<% if !instance_methods.empty? %>\n<%= section_header( \"Instance methods:\" ) %>\n<%= Bri::Renderer.wrap_list( instance_methods.sort ) %>\n\n\n<% end %>\n<% if !attributes.empty? %>\n<%= section_header( \"Attributes:\" ) %>\n<%= Bri::Renderer.wrap_list( attributes.sort ) %>\n\n\n<% end %>\n"

METHOD_DESCRIPTION =

"<%= hrule( full_name ) %>\n<%= print_origin( origin ) %>\n\n<%= call_syntaxes %>\n<%= hrule %>\n<% if description_paragraphs.empty? %>\n  (no description...)\n<% else %>\n<%= description_paragraphs.join( \"\\n\" ) %>\n<% end %>\n\n"