Permalink
Browse files

document Cursor

  • Loading branch information...
1 parent 8a04f29 commit c03644ea76b67aa97345b6ab1ed9117de88c8559 @moritz moritz committed Jul 31, 2012
Showing with 14 additions and 0 deletions.
  1. +14 −0 lib/Cursor.pod
View
@@ -0,0 +1,14 @@
+=begin pod
+
+=TITLE class Cursor
+
+ class Cursor { }
+
+A C<Cursor> object is used interally by the regex engine in regex matches
+to keep track of the current position, backtracking waypoints and information
+about capturing groups.
+
+A user-space program usually doesn't need to deal with C<Cursor> objects,
+just with their relatives, L<Match> objects.
+
+=end pod

0 comments on commit c03644e

Please sign in to comment.