lib/activefacts/cql.rb in activefacts-0.7.0 vs lib/activefacts/cql.rb in activefacts-0.7.1

@@ -1,21 +1,24 @@
 #
-# ActiveFacts CQL loader.
-# Copyright (c) 2007 Clifford Heath. Read the LICENSE file.
+#       ActiveFacts CQL loader.
+#       Use Polyglot to patch things so you can *require* a CQL file and have it define a Ruby module.
 #
+# Copyright (c) 2009 Clifford Heath. Read the LICENSE file.
+#
 require 'rubygems'
 require 'polyglot'
 require 'activefacts/support'
 require 'activefacts/input/cql'
 require 'activefacts/generate/ruby'
 
 module ActiveFacts
-  # Extend the generated parser:
+  # This class has a load method for Polyglot to tell it how to _require_ a CQL file.
+  # The CQL file is parsed to a vocabulary constellation, which is generated
+  # to Ruby code and eval'd, making the generated classes available.
+  # To make this Loader available, simply
+  #   require 'activefacts/cql'
   class CQLLoader
-    # This load method for Polyglot tells it how to _require_ a CQL file.
-    # The CQL file is parsed to a vocabulary constellation, which is generated
-    # to Ruby code and eval'd, making the generated classes available.
-    def self.load(file)
+    def self.load(file) #:nodoc:
       debug "Loading #{file}" do
         vocabulary = ActiveFacts::Input::CQL.readfile(file)
 
         ruby = StringIO.new
         @dumper = ActiveFacts::Generate::RUBY.new(vocabulary.constellation)