Sha256: 47c766124a2a57c98719ba26d5f01741eff85422930a5789f265f22fa19740eb

Contents?: true

Size: 1.87 KB

Versions: 30

Compression:

Stored size: 1.87 KB

Contents

class Foo
  attr_accessor :ignoreme

  # IMPLICIT METHOD!
  # @return [String]
  just_a_method_for :implicit0

  # IMPLICIT METHOD2!
  # @!scope class
  just_a_method_for :implicit1

  # IMPLICIT METHOD3!
  # @!visibility protected
  just_a_method_for :implicit2

  # Not recognized
  just_a_method_for :implicit_invalid

  #
  ## IS NOT RECOGNIZED!
  just_a_method_for :implicit_invalid2

  # @deprecated don't use this
  just_a_method_for :implicit_invalid3

  ##
  # IS RECOGNIZED!
  just_a_method_for 'implicit_valid'

  # @!attribute [r]
  # @return [Numeric] a number
  a_readable_attribute :attr1

  # @!attribute [w]
  a_writable_attribute :attr2, 'bar'

  # @!attribute
  default_attribute :attr3

  # @!attribute custom
  default_attribute :attr4

  # @!method xyz(a, b, c)
  # The foo method
  # @param [String] a
  # @!visibility protected
  # @!scope class
  foo_bar

  # @!macro property
  #   @!method $1(${3-})
  #   A $0 that is awesome.
  #   @param $3 first parameter
  #   @return [$2] the property $1
  property :name, String, :a, :b, :c

  # @!macro property
  property :age, Fixnum, :value

  # This is just for x
  # @!macro [attach] parser
  #   @!method $1(opts = {})
  #   @return NOTHING!
  parser :x

  parser :c_parser

  # Another docstring
  parser :d_parser

  # @!macro [attach] none
  #   @!method none(foo, bar)
  none

  # @!macro something
  #   @!method $1(a, b, c)
  something :qux

  # @!method qux2(a, b, c)
  something

  # @!macro
  #   $1 $2 $3
  def regular_meth(a, b, c) end

  # @!macro [new] different
  #   @!method $2_name(a = 1)

  # @!macro different
  implicit_with_different_method_name :wrong, :right

  # @!scope module
  a_module_function :modfunc1
end

class Bar
  parser :x_parser
end

class Baz < Foo
  parser :y_parser
  none { }
end

# @!method my_other_method
# Docstring for method
method_that_makes_a_method

# @!macro something
foobarbaz :beep

Version data entries

30 entries across 21 versions & 3 rubygems

Version Path
challah-1.0.0.beta vendor/bundle/gems/yard-0.8.3/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.9.1.beta.3 vendor/bundle/gems/yard-0.8.3/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.9.1.beta vendor/bundle/gems/yard-0.8.3/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.9.0 vendor/bundle/gems/yard-0.8.3/spec/handlers/examples/dsl_handler_001.rb.txt
challah-rolls-0.2.0 vendor/bundle/gems/challah-0.8.3/vendor/bundle/gems/yard-0.8.3/spec/handlers/examples/dsl_handler_001.rb.txt
challah-rolls-0.2.0 vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-rolls-0.2.0 vendor/bundle/gems/challah-0.8.0.pre/vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-rolls-0.2.0 vendor/bundle/gems/challah-0.8.3/vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-rolls-0.2.0 vendor/bundle/gems/yard-0.8.3/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.8.3 vendor/bundle/gems/yard-0.8.3/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.8.3 vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
yard-0.8.3 spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.8.1 vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-rolls-0.1.0 vendor/bundle/gems/challah-0.8.0.pre/vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-rolls-0.1.0 vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.8.0.pre vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.7.1 vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.7.0 vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.7.0.pre2 vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt
challah-0.7.0.pre vendor/bundle/gems/yard-0.8.2.1/spec/handlers/examples/dsl_handler_001.rb.txt