lib/docparser/document.rb in docparser-0.1.6 vs lib/docparser/document.rb in docparser-0.2.0
- old
+ new
@@ -2,10 +2,20 @@
module DocParser
# The Document class loads and parses the files.
# @see Parser
# @see Output
class Document
- attr_reader :filename, :doc, :encoding, :results
+ # @return [String] the filename of the current document
+ attr_reader :filename
+
+ # @return [Nokogiri::HTML::Document] a reference to the Nokogiri document
+ attr_reader :doc
+
+ # @return [String] the encoding of the document
+ attr_reader :encoding
+
+ # @return [Array] the results from this document
+ attr_reader :results
# @return [String] the source of the document
attr_reader :html
def initialize(filename: nil, encoding: 'utf-8', parser: nil)