class Brainstem::ApiDocs::Formatters::Markdown::ControllerFormatter
Attributes
controller[RW]
include_actions[RW]
include_actions?[RW]
output[RW]
Public Class Methods
new(controller, options = {})
click to toggle source
Calls superclass method
Brainstem::ApiDocs::Formatters::AbstractFormatter::new
# File lib/brainstem/api_docs/formatters/markdown/controller_formatter.rb, line 26 def initialize(controller, options = {}) self.controller = controller self.output = "" self.include_actions = false super options end
Public Instance Methods
call()
click to toggle source
# File lib/brainstem/api_docs/formatters/markdown/controller_formatter.rb, line 33 def call return output if controller.nodoc? format_title! format_description! format_actions! end
valid_options()
click to toggle source
Declares the options that are permissable to set on this instance.
Calls superclass method
Brainstem::Concerns::Optional#valid_options
# File lib/brainstem/api_docs/formatters/markdown/controller_formatter.rb, line 14 def valid_options super | [ :include_actions ] end
Private Instance Methods
format_actions!()
click to toggle source
# File lib/brainstem/api_docs/formatters/markdown/controller_formatter.rb, line 52 def format_actions! return unless include_actions? output << md_h3("Endpoints") output << controller.valid_sorted_endpoints .formatted_as(:markdown, zero_text: "No endpoints were found.") end
format_description!()
click to toggle source
# File lib/brainstem/api_docs/formatters/markdown/controller_formatter.rb, line 48 def format_description! output << md_p(controller.description) unless controller.description.empty? end
format_title!()
click to toggle source
# File lib/brainstem/api_docs/formatters/markdown/controller_formatter.rb, line 44 def format_title! output << md_h2(controller.title) end