lib/to_pass/converter.rb in to_pass-0.5.2 vs lib/to_pass/converter.rb in to_pass-0.6.0

@@ -1,15 +1,17 @@
 # -*- coding: utf-8 -*-
 # vim:ft=ruby:enc=utf-8
 
-module ToPass
+module ToPass # :nodoc:
   # converts a given string into a password-like word
   #
   # the string can be a word or a sentence. everthing which
   # contains whitespace is considered a sentence
   #
   # a more complete description of the algorithm capabilities
   # is still pending.
+  #
+  # see ToPass::ConverterReader and ToPass::AlgorithmReader
   class Converter
     attr_accessor :converters, :rules
     # create a new converter, based on a set of conversion-rules
     def initialize( rules )
       @rules = rules