Improve inline documentation

Author: gmitrev

lib/egn/egn.rb

@@ -3,10 +3,10 @@ module Egn
   class Egn
     attr_reader :number, :birth_date
 
-    # Creates a new EGN object. Has different effects depending on the argument.
-    # When no arguments are given, it generates a new random EGN
-    # When a String is given, it is assumed that it is an EGN and is parsed
-    # When a hash is given, a new EGN is generated with the provided options
+    # Creates a new EGN object. Has different effects depending on the arguments:
+    # when no arguments are given, it generates a new random EGN;
+    # when a String is given, it is parsed as an EGN;
+    # when a hash is given, a new EGN is generated with the provided options.
     def initialize(args=nil)
 
       if args.nil?

lib/egn/generator.rb

@@ -3,7 +3,7 @@ module Egn
   class Generator
     attr_reader :options
 
-    # Convinience method
+    # Convenience method
     def self.generate(options={})
       Generator.new(options).generate
     end
@@ -14,7 +14,7 @@ def initialize(options={})
       process!
     end
 
-    # The generated EGN will be completely random if no opitons are given.
+    # The generated EGN will be completely random if no options are given.
     # options is a hash that may have the following keys: :year, :month, :day, :gender
     def generate
       egn = format(options[:year]) +
@@ -36,7 +36,7 @@ def set_defaults!(options)
 
     end
 
-    # Little helper
+    # Little helper that prefixes strings with 0s
     def format(val, pre=2)
       val.to_s.rjust(pre, '0')
     end