diff options
| author | gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-02-19 12:32:09 +0000 |
|---|---|---|
| committer | gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-02-19 12:32:09 +0000 |
| commit | 6af452319194f9d8cecfc51ca4f476919cb86a6f (patch) | |
| tree | 54477232af5624eff61aeb2fbacc929ad939a175 /ext/strscan | |
| parent | 78b0cb1d85b57d0204d4154a5c106721c3dca8a7 (diff) | |
| download | ruby-6af452319194f9d8cecfc51ca4f476919cb86a6f.tar.gz ruby-6af452319194f9d8cecfc51ca4f476919cb86a6f.tar.xz ruby-6af452319194f9d8cecfc51ca4f476919cb86a6f.zip | |
* ext/strscan/strscan.c: improved documentation
git-svn-id: http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8@5781 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/strscan')
| -rw-r--r-- | ext/strscan/strscan.c | 65 |
1 files changed, 35 insertions, 30 deletions
diff --git a/ext/strscan/strscan.c b/ext/strscan/strscan.c index e33f610c7..227ed9230 100644 --- a/ext/strscan/strscan.c +++ b/ext/strscan/strscan.c @@ -1169,6 +1169,8 @@ inspect2(p) ======================================================================= */ /* + * Document-class: StringScanner + * * StringScanner provides for lexical scanning operations on a String. Here is * an example of its usage: * @@ -1194,8 +1196,9 @@ inspect2(p) * p s.scan(/\w+/) # -> nil * * Scanning a string means remembering the position of a <i>scan pointer</i>, - * which is just an index. The scan pointer effectively points _between_ - * characters. (XXX: get this right - is it between or not?) + * which is just an index. The point of scanning is to move forward a bit at + * a time, so matches are sought after the scan pointer; usually immediately + * after it. * * Given the string "test string", here are the pertinent scan pointer * positions: @@ -1220,49 +1223,51 @@ inspect2(p) * * === Advancing the Scan Pointer * - * getch - * getbyte - * scan - * scan_until - * skip - * skip_until + * - #getch + * - #getbyte + * - #scan + * - #scan_until + * - #skip + * - #skip_until * * === Looking Ahead * - * check - * check_until - * exist? - * match? - * peek + * - #check + * - #check_until + * - #exist? + * - #match? + * - #peek * * === Finding Where we Are * - * bol? - * eos? - * pos + * - #bol? + * - #eos? + * - #rest? + * - #rest_size + * - #pos * * === Setting Where we Are * - * reset - * terminate - * pos= + * - #reset + * - #terminate + * - #pos= * * === Match Data * - * matched - * matched? - * matched_size - * [] - * pre_match - * post_match + * - #matched + * - #matched? + * - #matched_size + * - [] + * - #pre_match + * - #post_match * * === Miscellaneous * - * << - * concat - * string - * string= - * unscan + * - << + * - #concat + * - #string + * - #string= + * - #unscan * * There are aliases to several of the methods. */ |