From 4c01ff6ef9761ac4eb479dfc0d5ee3d25e9a2bc2 Mon Sep 17 00:00:00 2001
From: murphy <murphy@rubychan.de>
Date: Sat, 5 Nov 2005 03:55:19 +0000
Subject: helpers/word_list.rb: enhanced doc a bit.

---
 lib/coderay/helpers/word_list.rb | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'lib/coderay/helpers')

diff --git a/lib/coderay/helpers/word_list.rb b/lib/coderay/helpers/word_list.rb
index a74705d..1371446 100644
--- a/lib/coderay/helpers/word_list.rb
+++ b/lib/coderay/helpers/word_list.rb
@@ -9,6 +9,8 @@ module CodeRay
 			# WordList is highly optimized to be used in Scanners,
 			# typically to decide whether a given ident is a keyword.
 			#
+			# For case insensitive words use CaseIgnoringWordList.
+			#
 			# Example:
 			# 
 			#  # define word arrays
@@ -65,6 +67,12 @@ module CodeRay
 			end
 			
 
+			# A WordList is a Hash with some additional features.
+			# It is intended to be used for keyword recognition.
+			#
+			# Keys are compared case-insensitively.
+			#
+			# See WordList.
 			class CaseIgnoringWordList < WordList
 
 				# Creates a new WordList with +default+ as default value.
-- 
cgit v1.2.1