core
/
oga
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Short docs on lexer callback names.

This commit is contained in:
Yorick Peterse 2014-11-23 20:20:14 +01:00
parent 4fa88fcbde
commit 5e24a3d1e5
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ext/ragel/base_lexer.rl
View File

@ -28,6 +28,17 @@
# When you call a method in Ruby make sure that said method is defined as # When you call a method in Ruby make sure that said method is defined as
# an instance method in the `Oga::XML::Lexer` class. # an instance method in the `Oga::XML::Lexer` class.
# #
# The name of the callback to invoke should be an identifier starting with
# "id_". The identifier should be defined in the associated C and Java code.
# In case of C code its value should be a Symbol as a VALUE object, for Java
# it should be a String. For example:
#
# VALUE id_foo = rb_intern("foo");
#
# And for Java:
#
# String id_foo = "foo";
#
# ## Machine Transitions # ## Machine Transitions
# #
# To transition from one machine to another always use `fnext` instead of # To transition from one machine to another always use `fnext` instead of