Ruby Doc for code and other stuff

[Trilochan Bharadwaj]

Hi,

I just got started with Ruby (I am from Java world, and have played around with Haskell and Scala a bit); I am just wondering: What are the things that are wrong in this code, if someone can point it out, like from best practices and convention perspective and also How do I Ruby-Doc this, javadoc was pretty straight forward (especially with Eclipse), (I am using Eclipse Ruby IDE right now), here's my code:

    
# @(#)Module_Date_8_13_2008.rb 8/13/2009
#
# Copyright (c) Trilochan. All rights reserved.

# Summary
# ~~~~~~~~~~~~~~~~~~~~~~~~~~
# Module for todays learning.
# Targets: <br />
# 1.) Basic CONSOLE OUTPUTS
# 2.) Declaring Modules
# 3.) Declaring Classes
# 4.) Declaring instance variables
module Module_Date_8_13_2008

  # Funny this reminds me of C++ a bit ...
  # All public methods go here
  # ~~~~~~~~~~~~~~~~~~~~~~~~~~  
   public 
   
   # Summary
   # ~~~~~~~~~~~~~~~~~~~
   # Simple display, sorta hello World.
   def display(x)
      printf("OM Gum Ganapataye Namah");    
    end
    
    # Summary
    # ~~~~~~~~~~~~~~~~~~~~~~~~~~
    # Test if a functor can be passed in and invoked, your basic functor ... ya know ;)
    def anonymous_function_test(functor)
        functor();      
    end
    
    # Summary
    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~
    # Is Nil a concept in Ruby?
    def is_nil_a_concept_in_ruby()
      
    end
end

[Lasse Koskela]

From the command line you can do "rdoc [path to .rb file]" to generate the RDoc for a single file.
Most people tend to use build scripts (usually Rake) for doing this stuff for the whole project, though.