Define the public API using YARD/semver

This commit is contained in:
Yorick Peterse committed 2015-05-11 21:34:34 +02:00
1 parent 039edee9ec
commit df96b3d3bb
9 files changed
+19 -1

No files matched your search

+2
View File
@@ -16,6 +16,8 @@ module Oga
# multiple threads. However, no global state is used so you can use separate
# instances in threads just fine.
#
# @api private
#
class Lexer
%% write data;
+2
View File
@@ -10,6 +10,8 @@
# Similar to {Oga::XPath::Parser} this parser only takes String instances as
# input.
#
# @api private
#
}
%name Oga::CSS::Parser;
+2
View File
@@ -21,6 +21,8 @@ module Oga
#
# cache.keys # => [:b, :c, :d]
#
# @api private
#
class LRU
##
# @param [Fixnum] maximum
+2
View File
@@ -3,6 +3,8 @@ module Oga
# Class for storing (HTML) element names in a set and automatically adding
# their uppercase equivalents.
#
# @api private
#
class NodeNameSet < Set
##
# @param [Array] values
+2
View File
@@ -58,6 +58,8 @@ module Oga
#
# evaluator.evaluate('$number') # => 10
#
# @api private
#
class Evaluator
# Wildcard for node names/namespace prefixes.
STAR = '*'
+2
View File
@@ -32,6 +32,8 @@ module Oga
# use separate instances per thread as there is no global (= class level)
# shared state.
#
# @api private
#
class Lexer
%% write data;
+2
View File
@@ -6,6 +6,8 @@
#
# Unlike {Oga::XML::Parser} this parser only takes String instances as input.
#
# @api private
#
}
%name Oga::XPath::Parser;