Example class showing usage of yardoc ...

Foo.rb

#!/usr/bin/env ruby

class Foo

  # This is m1. It gets documented correctly.
  # @param [Integer] id an integer representing unique ID
  # @param [String] name string representing the name
  # @see #m2
  def m1(id, name)
  end

=begin
  This is m2. It does not get documented correctly.
  @param [String] name string representing the name
  @param [Integer] id an integer representing unique ID
  @see #m1
=end
  def m2(name, id)
  end
end