summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authormurphy <murphy@rubychan.de>2005-11-05 03:55:19 +0000
committermurphy <murphy@rubychan.de>2005-11-05 03:55:19 +0000
commit4c01ff6ef9761ac4eb479dfc0d5ee3d25e9a2bc2 (patch)
tree9915d5b5effeb7f40873e3ab23182052cc005f15 /lib
parenta4b1176d13a8f1c80f6bafc26b3d914f246cb6f8 (diff)
downloadcoderay-4c01ff6ef9761ac4eb479dfc0d5ee3d25e9a2bc2.tar.gz
helpers/word_list.rb: enhanced doc a bit.
Diffstat (limited to 'lib')
-rw-r--r--lib/coderay/helpers/word_list.rb8
1 files changed, 8 insertions, 0 deletions
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.