Skip to content

Commit baa3b62

Browse files
committed
Fixed/Modified JSDoc
1 parent 39ed076 commit baa3b62

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

lib/index.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ var utils = require('./utils'),
66
_ = require('lodash');
77

88
/**
9-
* Converts HTML to DOM Tree
10-
* @param {String} HTML
9+
* Converts HTML document to AST Tree
10+
* @param {String} HTMLDoc
1111
* @param {Object} options
1212
* @returns {AST}
1313
*/
14-
function htmlToAST(HTML, options) {
14+
function htmlToAST(HTMLDoc, options) {
1515
var parser,
1616
parserHandler;
1717

@@ -20,13 +20,13 @@ function htmlToAST(HTML, options) {
2020
}, options);
2121

2222
parser = new htmlParser.Parser(parserHandler);
23-
parser.parseComplete(HTML);
23+
parser.parseComplete(HTMLDoc);
2424

2525
return parserHandler.dom;
2626
}
2727

2828
/**
29-
*
29+
* Recursively sorts the arttibutes value of the AST leafs
3030
* @param {AST} tree
3131
* @param {Object} options
3232
* @returns {AST}
@@ -77,7 +77,7 @@ function modifyASTTree(tree, options) {
7777
* @param {String[]} [options.compareHtmlAttrsAsJSON]
7878
* @param {Boolean} [options.verbose]
7979
* @param {Boolean} [options.ignoreWhitespace=true]
80-
* @param {Boolean} [options.bem=true]
80+
* @param {Boolean} [options.bem=false]
8181
* @constructor
8282
*/
8383
var HtmlDiff = function(options) {
@@ -116,7 +116,7 @@ HtmlDiff.prototype.tokenize = function(value) {
116116
* @param {String[]} [options.compareHtmlAttrsAsJSON]
117117
* @param {Boolean} [options.verbose]
118118
* @param {Boolean} [options.ignoreWhitespace=true]
119-
* @param {Boolean} [options.bem=true]
119+
* @param {Boolean} [options.bem=false]
120120
* @constructor
121121
*/
122122
var HtmlDiffer = function(options) {

0 commit comments

Comments
 (0)