TomDoc examples #template #tomdoc #documentation

gistfile1.rb

# reference: http://tomdoc.org/

# Public: Add two numbers together.
#
# value1 - The first number.
# value2 - The second number.
#
# Examples
#
#   add(1, 2)
#   # => 3
#
# Returns the added numbers.
# Raises Error::100 if the file cannot be found.
def add(value1, value2)
  value1 + value2
end

# Public: Add two numbers together.
#
# options - The Hash options used to refine the selection (default: {}):
#           :value1 - The first value (optional).
#           :value2 - The second value (optional).
#
# Examples
#   options = { :value1 => 1, :value2 => 2 }
#   add(options)
#   # => 3
#
# Returns the added numbers.
# Raises Error::100 if the file cannot be found.
def add(options)
  options.value1 + options.value2
end

or

# Internal: Method used internally only.

# Deprecated: Method being removed.