rdoc_template.rb

# Description goes here!
#
# * *Params*    :
#   - ++ ->
# * *Headers*    :
#   - ++ ->
# * *Body*    :
#   - ++ ->
# * *Args*    :
#   - ++ ->
# * *Returns* :
#   -
# * *Raises*  :
#   - ++ ->
#
def some_function_name
end


# An example of properly formatted RDoc given the above template
#
# * *Args*    :
#   - +foo+ -> a foo for you
#   - +bar (optional)+ -> and a bar too
# * *Returns* :
#   - A new instance of the Baz class
# * *Raises* :
#   - +ArgumentError+ -> HTTP Status 400, invalid arguments based on type
#
def do_example foo bar
  unless foo.is_a?(Number) raise ArgumentError.new("foo should be a number") end
  unless bar.is_a?(String) raise ArgumentError.new("bar should be a string") end
  # some computation
  Baz.new
end

Basically this is here for reference because I always forget my nice RDoc formatting which gens some nice lists and formatting in the output of rake doc:app