Update some doc comments in the HTML node classes

Author: gregjacobs

src/htmlParser/ElementNode.js

@@ -2,56 +2,59 @@
 /**
  * @class Autolinker.htmlParser.ElementNode
  * @extends Autolinker.htmlParser.HtmlNode
- * 
+ *
  * Represents an HTML element node that has been parsed by the {@link Autolinker.htmlParser.HtmlParser}.
- * 
- * See this class's superclass ({@link Autolinker.htmlParser.HtmlNode}) for more details.
+ *
+ * See this class's superclass ({@link Autolinker.htmlParser.HtmlNode}) for more
+ * details.
  */
 Autolinker.htmlParser.ElementNode = Autolinker.Util.extend( Autolinker.htmlParser.HtmlNode, {
-	
+
 	/**
 	 * @cfg {String} tagName (required)
-	 * 
+	 *
 	 * The name of the tag that was matched.
 	 */
 	tagName : '',
-	
+
 	/**
 	 * @cfg {Boolean} closing (required)
-	 * 
-	 * `true` if the element (tag) is a closing tag, `false` if its an opening tag.
+	 *
+	 * `true` if the element (tag) is a closing tag, `false` if its an opening
+	 * tag.
 	 */
 	closing : false,
 
-	
+
 	/**
 	 * Returns a string name for the type of node that this class represents.
-	 * 
+	 *
 	 * @return {String}
 	 */
 	getType : function() {
 		return 'element';
 	},
-	
+
 
 	/**
-	 * Returns the HTML element's (tag's) name. Ex: for an <img> tag, returns "img".
-	 * 
+	 * Returns the HTML element's (tag's) name. Ex: for an <img> tag,
+	 * returns "img".
+	 *
 	 * @return {String}
 	 */
 	getTagName : function() {
 		return this.tagName;
 	},
-	
-	
+
+
 	/**
-	 * Determines if the HTML element (tag) is a closing tag. Ex: <div> returns
-	 * `false`, while </div> returns `true`.
-	 * 
+	 * Determines if the HTML element (tag) is a closing tag. Ex: <div>
+	 * returns `false`, while </div> returns `true`.
+	 *
 	 * @return {Boolean}
 	 */
 	isClosing : function() {
 		return this.closing;
 	}
-	
+
 } );

src/htmlParser/EntityNode.js

@@ -2,24 +2,26 @@
 /**
  * @class Autolinker.htmlParser.EntityNode
  * @extends Autolinker.htmlParser.HtmlNode
- * 
+ *
  * Represents a known HTML entity node that has been parsed by the {@link Autolinker.htmlParser.HtmlParser}.
- * Ex: ' ', or '&amp#160;' (which will be retrievable from the {@link #getText} method.
- * 
- * Note that this class will only be returned from the HtmlParser for the set of checked HTML entity nodes 
- * defined by the {@link Autolinker.htmlParser.HtmlParser#htmlCharacterEntitiesRegex}.
- * 
- * See this class's superclass ({@link Autolinker.htmlParser.HtmlNode}) for more details.
+ * Ex: ' ', or '&amp#160;' (which will be retrievable from the {@link #getText}
+ * method.
+ *
+ * Note that this class will only be returned from the HtmlParser for the set of
+ * checked HTML entity nodes  defined by the {@link Autolinker.htmlParser.HtmlParser#htmlCharacterEntitiesRegex}.
+ *
+ * See this class's superclass ({@link Autolinker.htmlParser.HtmlNode}) for more
+ * details.
  */
 Autolinker.htmlParser.EntityNode = Autolinker.Util.extend( Autolinker.htmlParser.HtmlNode, {
-	
+
 	/**
 	 * Returns a string name for the type of node that this class represents.
-	 * 
+	 *
 	 * @return {String}
 	 */
 	getType : function() {
 		return 'entity';
 	}
-	
+
 } );

src/htmlParser/HtmlNode.js

@@ -2,51 +2,61 @@
 /**
  * @abstract
  * @class Autolinker.htmlParser.HtmlNode
- * 
- * Represents an HTML node found in an input string. An HTML node is one of the following:
- * 
- * 1. An {@link Autolinker.htmlParser.ElementNode ElementNode}, which represents HTML tags.
- * 2. A {@link Autolinker.htmlParser.TextNode TextNode}, which represents text outside or within HTML tags.
- * 3. A {@link Autolinker.htmlParser.EntityNode EntityNode}, which represents one of the known HTML
- *    entities that Autolinker looks for. This includes common ones such as " and  
+ *
+ * Represents an HTML node found in an input string. An HTML node is one of the
+ * following:
+ *
+ * 1. An {@link Autolinker.htmlParser.ElementNode ElementNode}, which represents
+ *    HTML tags.
+ * 2. A {@link Autolinker.htmlParser.CommentNode CommentNode}, which represents
+ *    HTML comments.
+ * 3. A {@link Autolinker.htmlParser.TextNode TextNode}, which represents text
+ *    outside or within HTML tags.
+ * 4. A {@link Autolinker.htmlParser.EntityNode EntityNode}, which represents
+ *    one of the known HTML entities that Autolinker looks for. This includes
+ *    common ones such as " and  
  */
 Autolinker.htmlParser.HtmlNode = Autolinker.Util.extend( Object, {
-	
+
 	/**
 	 * @cfg {String} text (required)
-	 * 
-	 * The original text that was matched for the HtmlNode. 
-	 * 
-	 * - In the case of an {@link Autolinker.htmlParser.ElementNode ElementNode}, this will be the tag's
-	 *   text.
-	 * - In the case of a {@link Autolinker.htmlParser.TextNode TextNode}, this will be the text itself.
-	 * - In the case of a {@link Autolinker.htmlParser.EntityNode EntityNode}, this will be the text of
-	 *   the HTML entity.
+	 *
+	 * The original text that was matched for the HtmlNode.
+	 *
+	 * - In the case of an {@link Autolinker.htmlParser.ElementNode ElementNode},
+	 *   this will be the tag's text.
+	 * - In the case of an {@link Autolinker.htmlParser.CommentNode CommentNode},
+	 *   this will be the comment's text.
+	 * - In the case of a {@link Autolinker.htmlParser.TextNode TextNode}, this
+	 *   will be the text itself.
+	 * - In the case of a {@link Autolinker.htmlParser.EntityNode EntityNode},
+	 *   this will be the text of the HTML entity.
 	 */
 	text : "",
-	
-	
+
+
 	/**
 	 * @constructor
-	 * @param {Object} cfg The configuration properties for the Match instance, specified in an Object (map).
+	 * @param {Object} cfg The configuration properties for the Match instance,
+	 * specified in an Object (map).
 	 */
 	constructor : function( cfg ) {
 		Autolinker.Util.assign( this, cfg );
 	},
 
-	
+
 	/**
 	 * Returns a string name for the type of node that this class represents.
-	 * 
+	 *
 	 * @abstract
 	 * @return {String}
 	 */
 	getType : Autolinker.Util.abstractMethod,
-	
-	
+
+
 	/**
 	 * Retrieves the {@link #text} for the HtmlNode.
-	 * 
+	 *
 	 * @return {String}
 	 */
 	getText : function() {

src/htmlParser/TextNode.js

@@ -2,20 +2,21 @@
 /**
  * @class Autolinker.htmlParser.TextNode
  * @extends Autolinker.htmlParser.HtmlNode
- * 
+ *
  * Represents a text node that has been parsed by the {@link Autolinker.htmlParser.HtmlParser}.
- * 
- * See this class's superclass ({@link Autolinker.htmlParser.HtmlNode}) for more details.
+ *
+ * See this class's superclass ({@link Autolinker.htmlParser.HtmlNode}) for more
+ * details.
  */
 Autolinker.htmlParser.TextNode = Autolinker.Util.extend( Autolinker.htmlParser.HtmlNode, {
-	
+
 	/**
 	 * Returns a string name for the type of node that this class represents.
-	 * 
+	 *
 	 * @return {String}
 	 */
 	getType : function() {
 		return 'text';
 	}
-	
+
 } );