Removed usage of YARD @!attribute macros
This commit is contained in:
		
							parent
							
								
									2c18a51ba9
								
							
						
					
					
						commit
						bcffd86c50
					
				|  | @ -3,19 +3,17 @@ module Oga | |||
|     ## | ||||
|     # Class for storing information about a single XML attribute. | ||||
|     # | ||||
|     # @!attribute [rw] name | ||||
|     #  The name of the attribute. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [rw] namespace_name | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [r] element | ||||
|     #  The element this attribute belongs to. | ||||
|     #  @return [Oga::XML::Element] | ||||
|     # | ||||
|     class Attribute | ||||
|       attr_accessor :name, :namespace_name, :element | ||||
|       # The name of the attribute. | ||||
|       # @return [String] | ||||
|       attr_accessor :name | ||||
| 
 | ||||
|       # @return [String] | ||||
|       attr_accessor :namespace_name | ||||
| 
 | ||||
|       # The element this attribute belongs to. | ||||
|       # @return [Oga::XML::Element] | ||||
|       attr_accessor :element | ||||
| 
 | ||||
|       ## | ||||
|       # The default namespace available to all attributes. This namespace can | ||||
|  |  | |||
|  | @ -4,10 +4,8 @@ module Oga | |||
|     # Base class for nodes that represent a text-like value such as Text and | ||||
|     # Comment nodes. | ||||
|     # | ||||
|     # @!attribute [rw] text | ||||
|     #  @return [String] | ||||
|     # | ||||
|     class CharacterNode < Node | ||||
|       # @return [String] | ||||
|       attr_accessor :text | ||||
| 
 | ||||
|       ## | ||||
|  |  | |||
|  | @ -3,28 +3,26 @@ module Oga | |||
|     ## | ||||
|     # Class used for storing information about Doctypes. | ||||
|     # | ||||
|     # @!attribute [rw] name | ||||
|     #  The name of the doctype (e.g. "HTML"). | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [rw] type | ||||
|     #  The type of the doctype (e.g. "PUBLIC"). | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [rw] public_id | ||||
|     #  The public ID of the doctype. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [rw] system_id | ||||
|     #  The system ID of the doctype. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [rw] inline_rules | ||||
|     #  The inline doctype rules. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     class Doctype | ||||
|       attr_accessor :name, :type, :public_id, :system_id, :inline_rules | ||||
|       # The name of the doctype (e.g. "HTML"). | ||||
|       # @return [String] | ||||
|       attr_accessor :name | ||||
| 
 | ||||
|       # The type of the doctype (e.g. "PUBLIC"). | ||||
|       # @return [String] | ||||
|       attr_accessor :type | ||||
| 
 | ||||
|       # The public ID of the doctype. | ||||
|       # @return [String] | ||||
|       attr_accessor :public_id | ||||
| 
 | ||||
|       # The system ID of the doctype. | ||||
|       # @return [String] | ||||
|       attr_accessor :system_id | ||||
| 
 | ||||
|       # The inline doctype rules. | ||||
|       # @return [String] | ||||
|       attr_accessor :inline_rules | ||||
| 
 | ||||
|       ## | ||||
|       # @example | ||||
|  |  | |||
|  | @ -4,24 +4,18 @@ module Oga | |||
|     # Class used for storing information about an entire XML document. This | ||||
|     # includes the doctype, XML declaration, child nodes and more. | ||||
|     # | ||||
|     # @!attribute [rw] doctype | ||||
|     #  The doctype of the document. | ||||
|     #  @return [Oga::XML::Doctype] | ||||
|     # | ||||
|     # @!attribute [rw] xml_declaration | ||||
|     #  The XML declaration of the document. | ||||
|     #  @return [Oga::XML::XmlDeclaration] | ||||
|     # | ||||
|     # @!attribute [r] type | ||||
|     #  The document type, either `:xml` or `:html`. | ||||
|     #  @return [Symbol] | ||||
|     # | ||||
|     class Document | ||||
|       include Querying | ||||
|       include Traversal | ||||
| 
 | ||||
|       attr_accessor :doctype, :xml_declaration | ||||
|       # @return [Oga::XML::Doctype] | ||||
|       attr_accessor :doctype | ||||
| 
 | ||||
|       # @return [Oga::XML::XmlDeclaration] | ||||
|       attr_accessor :xml_declaration | ||||
| 
 | ||||
|       # The document type, either `:xml` or `:html`. | ||||
|       # @return [Symbol] | ||||
|       attr_reader :type | ||||
| 
 | ||||
|       ## | ||||
|  |  | |||
|  | @ -4,29 +4,19 @@ module Oga | |||
|     # Class that contains information about an XML element such as the name, | ||||
|     # attributes and child nodes. | ||||
|     # | ||||
|     # @!attribute [rw] name | ||||
|     #  The name of the element. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [r] namespace_name | ||||
|     #  The name of the namespace. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [rw] attributes | ||||
|     #  The attributes of the element. | ||||
|     #  @return [Array<Oga::XML::Attribute>] | ||||
|     # | ||||
|     # @!attribute [rw] namespaces | ||||
|     #  The registered namespaces. | ||||
|     #  @return [Hash] | ||||
|     # | ||||
|     class Element < Node | ||||
|       include Querying | ||||
| 
 | ||||
|       # @return [String] | ||||
|       attr_reader :namespace_name | ||||
| 
 | ||||
|       attr_accessor :name, :attributes | ||||
|       # @return [String] | ||||
|       attr_accessor :name | ||||
| 
 | ||||
|       # @return [Array<Oga::XML::Attribute>] | ||||
|       attr_accessor :attributes | ||||
| 
 | ||||
|       # @return [Hash] | ||||
|       attr_writer :namespaces | ||||
| 
 | ||||
|       ## | ||||
|  |  | |||
|  | @ -4,14 +4,12 @@ module Oga | |||
|     # The Namespace class contains information about XML namespaces such as the | ||||
|     # name and URI. | ||||
|     # | ||||
|     # @!attribute [r] name | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [r] uri | ||||
|     #  @return [String] | ||||
|     # | ||||
|     class Namespace | ||||
|       attr_accessor :name, :uri | ||||
|       # @return [String] | ||||
|       attr_accessor :name | ||||
| 
 | ||||
|       # @return [String] | ||||
|       attr_accessor :uri | ||||
| 
 | ||||
|       ## | ||||
|       # @param [Hash] options | ||||
|  |  | |||
|  | @ -5,12 +5,10 @@ module Oga | |||
|     # {Oga::XML::NodeSet} and can be used to query surrounding and parent | ||||
|     # nodes. | ||||
|     # | ||||
|     # @!attribute [r] node_set | ||||
|     #  @return [Oga::XML::NodeSet] | ||||
|     # | ||||
|     class Node | ||||
|       include Traversal | ||||
| 
 | ||||
|       # @return [Oga::XML::NodeSet] | ||||
|       attr_reader :node_set | ||||
| 
 | ||||
|       ## | ||||
|  |  | |||
|  | @ -31,12 +31,10 @@ module Oga | |||
|     # If ownership was not handled then you'd have to manually set the | ||||
|     # `element` variable's `node_set` attribute after pushing it into a set. | ||||
|     # | ||||
|     # @!attribute [rw] owner | ||||
|     #  @return [Oga::XML::Node] | ||||
|     # | ||||
|     class NodeSet | ||||
|       include Enumerable | ||||
| 
 | ||||
|       # @return [Oga::XML::Node] | ||||
|       attr_accessor :owner | ||||
| 
 | ||||
|       ## | ||||
|  |  | |||
|  | @ -3,10 +3,8 @@ module Oga | |||
|     ## | ||||
|     # Class used for storing information about a single processing instruction. | ||||
|     # | ||||
|     # @!attribute [rw] name | ||||
|     #  @return [String] | ||||
|     # | ||||
|     class ProcessingInstruction < CharacterNode | ||||
|       # @return [String] | ||||
|       attr_accessor :name | ||||
| 
 | ||||
|       ## | ||||
|  |  | |||
|  | @ -19,16 +19,13 @@ module Oga | |||
|     # This parses yields proper XML instances such as {Oga::XML::Element}. | ||||
|     # Doctypes and XML declarations are ignored by this parser. | ||||
|     # | ||||
|     # @!attribute [r] node | ||||
|     #  The current node. | ||||
|     #  @return [Oga::XML::Node] | ||||
|     # | ||||
|     # @!attribute [r] nesting | ||||
|     #  Array containing the names of the currently nested elements. | ||||
|     #  @return [Array] | ||||
|     # | ||||
|     class PullParser < Parser | ||||
|       attr_reader :node, :nesting | ||||
|       # @return [Oga::XML::Node] | ||||
|       attr_reader :node | ||||
| 
 | ||||
|       # Array containing the names of the currently nested elements. | ||||
|       # @return [Array] | ||||
|       attr_reader :nesting | ||||
| 
 | ||||
|       ## | ||||
|       # @return [Array] | ||||
|  |  | |||
|  | @ -3,20 +3,16 @@ module Oga | |||
|     ## | ||||
|     # Class containing information about an XML declaration tag. | ||||
|     # | ||||
|     # @!attribute [rw] version | ||||
|     #  The XML version. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [rw] encoding | ||||
|     #  The XML document's encoding. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     # @!attribute [rw] standalone | ||||
|     #  Whether or not the document is a standalone document. | ||||
|     #  @return [String] | ||||
|     # | ||||
|     class XmlDeclaration | ||||
|       attr_accessor :version, :encoding, :standalone | ||||
|       # @return [String] | ||||
|       attr_accessor :version | ||||
| 
 | ||||
|       # @return [String] | ||||
|       attr_accessor :encoding | ||||
| 
 | ||||
|       # Whether or not the document is a standalone document. | ||||
|       # @return [String] | ||||
|       attr_accessor :standalone | ||||
| 
 | ||||
|       ## | ||||
|       # @param [Hash] options | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue