documentated.rb

#
# things.rb - a superfun time library
#
# Author: Jeremy McAnally 1998-2010
#
# Documentation: Mr. Jeremy McAnally
#
#--
# $Id: things.rb,v 2.22 2009-01-17 20:16:31+09 tadf Exp $
#++
#
#
# = things.rb - A library for Fun
#
# A one sentence description.
#
# == Overview
#
# A detailed description of the purpose of the library and its general usage patterns.
#
# == Usage
#
# === Subtask (e.g., "Reading files")
#
#   # Short, one-off examples
#   puts 'Quick!"
#
# === Subtask (e.g., "Reading files")
#
#   # Short, one-off examples
#   puts 'Quick!"
#
# == Examples
#
# If required, long-form examples showing "real" use cases.
#
# == Core extensions
#
# Documentation of any core extensions this file/module/class adds.
#
class Foo

  # A method to do something spectacular.
  #
  # === Examples
  #
  #   foobert("fail", "win")
  #   # => "The opposite of fail, is win."
  #
  # === Arguments
  #
  # * +one+ - The first thing
  # * +two+ - The other things
  #
  def foobert(one, two)

  end

end