Contents

require 'jazzy/source_declaration/access_control_level'
require 'jazzy/source_declaration/type'

module Jazzy
  class SourceDeclaration
    # kind of declaration (e.g. class, variable, function)
    attr_accessor :type
    # static type of declared element (e.g. String.Type -> ())
    attr_accessor :typename
    attr_accessor :file
    attr_accessor :line
    attr_accessor :column
    attr_accessor :usr
    attr_accessor :name
    attr_accessor :declaration
    attr_accessor :abstract
    attr_accessor :discussion
    attr_accessor :return
    attr_accessor :children
    attr_accessor :parameters
    attr_accessor :url
    attr_accessor :mark
    attr_accessor :access_control_level
    attr_accessor :start_line
    attr_accessor :end_line
    attr_accessor :nav_order

    def overview
      "#{abstract}\n\n#{discussion}".strip
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
jazzy-0.3.2	lib/jazzy/source_declaration.rb
jazzy-0.3.1	lib/jazzy/source_declaration.rb
jazzy-0.3.0	lib/jazzy/source_declaration.rb