summaryrefslogtreecommitdiff
path: root/lib/coderay.rb
diff options
context:
space:
mode:
authormurphy <murphy@rubychan.de>2005-09-29 21:08:55 +0000
committermurphy <murphy@rubychan.de>2005-09-29 21:08:55 +0000
commitc82038f0985992a1be4d2f3806ff00d214a0e769 (patch)
tree5047fbaa155513ddfd0b226bf0faed3415f04970 /lib/coderay.rb
parent97cf6619f565d462c769e0d611affa85a040ef40 (diff)
downloadcoderay-c82038f0985992a1be4d2f3806ff00d214a0e769.tar.gz
doc'ed on coderay.rb
Diffstat (limited to 'lib/coderay.rb')
-rw-r--r--lib/coderay.rb7
1 files changed, 3 insertions, 4 deletions
diff --git a/lib/coderay.rb b/lib/coderay.rb
index 05ef668..1517487 100644
--- a/lib/coderay.rb
+++ b/lib/coderay.rb
@@ -1,4 +1,4 @@
-# = CodeRay
+# = CodeRay Library
#
# $Id$
#
@@ -10,7 +10,7 @@
# See README.
#
# It consists mainly of
-# * the main engine: CodeRay, CodeRay::Scanner, CodeRay::Tokens, CodeRay::TokenStream, CodeRay::Encoder
+# * the main engine: CodeRay (Scanners::Scanner, Tokens/TokenStream, Encoders::Encoder), PluginHost
# * the scanners in CodeRay::Scanners
# * the encoders in CodeRay::Encoders
#
@@ -58,8 +58,7 @@
#
# and look at the file it created.
#
-
-# = CodeRay
+# = CodeRay Module
#
# The CodeRay module provides convenience methods for the engine.
#