YARD-Value

YARD-Value provides YARD handlers for Value objects. It’ll document whether the Value is Comparable and what attributes are used in such comparisons, its #initialize method, and its protected accessors.

You add the documentation to the Module#Value invocation. Any @param tags are used both for the parameters to the #initialize method and for the protected accessors.

This

class Point
  # A point on a plane.
  # @param [Integer] x
  # @param [Integer] y
  Value :x, :y
end

generates documentation similar to

class Point
  # A point on a plane.
  # @param [Integer] x
  # @param [Integer] y
  def initialize(x, y)
end

and this

class Point
  # A point on a plane.
  # @param [Integer] x The x coordinate of the receiver
  # @param [Integer] y The y coordinate of the receiver
  Value :x, :y
end

generates documentation similar to

class Point
  # A point on a plane.
  # @param [Integer] x
  # @param [Integer] y
  def initialize(x, y)

  protected

  # @return [Integer] The x coordinate of the receiver
  attr_reader :x

  # @return [Integer] The y coordinate of the receiver
  attr_reader :y
end

For comparable Values, a note is added about what attributes are used in the comparison. This

class Point
  # A point on a plane.
  # @param [Integer] x
  # @param [Integer] y
  Value :x, :y, :comparable => true
end

is similar to

class Point
  # A point on a plane.
  # @param [Integer] x
  # @param [Integer] y
  # @note Comparisons between instances are made between x and y.
  def initialize(x, y)
end

Inventory::Rake::Tasks::YARD.new do |t|
  t.options += %w'--plugin yard-value-1.0'
end