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

Added simple method docs for the XPath compiler

This commit is contained in:
Yorick Peterse 2015-07-09 01:32:04 +02:00
parent 2c1b4e7cbc
commit 17f6b3a3bb
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
lib/oga/xpath/compiler.rb
View File

@ -66,6 +66,8 @@ module Oga
end end
## ##
# Processes a relative path.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]
@ -96,6 +98,8 @@ module Oga
end end
## ##
# Processes an absolute path.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]
@ -126,6 +130,8 @@ module Oga
end end
## ##
# Processes the "child" axis.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]
@ -140,6 +146,8 @@ module Oga
end end
## ##
# Processes the "attribute" axis.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]
@ -153,6 +161,8 @@ module Oga
end end
## ##
# Processes a node test predicate.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]
@ -166,6 +176,8 @@ module Oga
end end
## ##
# Processes a node test.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]
@ -187,6 +199,8 @@ module Oga
end end
## ##
# Processes an equality expression.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]
@ -198,6 +212,8 @@ module Oga
end end
## ##
# Processes a string.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]
@ -207,6 +223,8 @@ module Oga
end end
## ##
# Processes an integer.
#
# @param [AST::Node] ast # @param [AST::Node] ast
# @param [Oga::Ruby::Node] input # @param [Oga::Ruby::Node] input
# @return [Oga::Ruby::Node] # @return [Oga::Ruby::Node]