Module: WashoutBuilderMethodReturnTypeHelper
- Includes:
- WashoutBuilderSharedHelper
- Defined in:
- app/helpers/washout_builder_method_return_type_helper.rb
Overview
helper that is used to create the return types of methods in HTML documentation
Instance Method Summary collapse
-
#create_html_public_method_return_type(xml, pre, output) ⇒ String
this method will print the return type next to the method name.
-
#html_public_method_complex_type(pre, output, complex_class) ⇒ void
this method will go through each of the arguments print them and then check if we need a spacer after it.
Methods included from WashoutBuilderSharedHelper
#find_class_from_string, #find_correct_complex_type
Instance Method Details
#create_html_public_method_return_type(xml, pre, output) ⇒ String
this method will print the return type next to the method name
16 17 18 19 20 21 22 23 24 25 26 27 |
# File 'app/helpers/washout_builder_method_return_type_helper.rb', line 16 def create_html_public_method_return_type(xml, pre, output) if !output.nil? && !output[0].blank? complex_class = output[0].find_complex_class_name if WashoutBuilder::Type::BASIC_TYPES.include?(output[0].type) xml.span('class' => 'blue') { |y| y << "#{output[0].type}" } else html_public_method_complex_type(pre, output, complex_class) end else pre << 'void' end end |
#html_public_method_complex_type(pre, output, complex_class) ⇒ void
This method returns an undefined value.
this method will go through each of the arguments print them and then check if we need a spacer after it
39 40 41 42 43 44 45 46 47 48 |
# File 'app/helpers/washout_builder_method_return_type_helper.rb', line 39 def html_public_method_complex_type(pre, output, complex_class) return if complex_class.nil? real_class = find_correct_complex_type(complex_class) if output[0].multiplied complex_return_type = "Array of #{real_class}" else complex_return_type = "#{real_class}" end pre << "<a href='##{real_class}'><span class='lightBlue'>#{complex_return_type}</span></a>" end |