diff --git a/README.md b/README.md index 1986648..4a55131 100644 --- a/README.md +++ b/README.md @@ -126,11 +126,11 @@ Node.js bindings for libxslt compatible with libxmljs * [libxslt](#module_libxslt) * [libxslt.parse(source, [callback])](#module_libxslt.parse) - * [libxslt.parseFile(sourcePath, [callback])](#module_libxslt.parseFile) + * [libxslt.parseFile(sourcePath, callback)](#module_libxslt.parseFile) * [class: libxslt~Stylesheet](#module_libxslt..Stylesheet) * [new libxslt~Stylesheet(stylesheetDoc, stylesheetObj)](#new_module_libxslt..Stylesheet) * [stylesheet.apply(source, [params], [callback])](#module_libxslt..Stylesheet#apply) - * [stylesheet.applyToFile(sourcePath, [params], [callback])](#module_libxslt..Stylesheet#applyToFile) + * [stylesheet.applyToFile(sourcePath, [params], callback)](#module_libxslt..Stylesheet#applyToFile) ##libxslt.parse(source, [callback]) @@ -145,13 +145,13 @@ If no callback is given the function will run synchronously and return the resul **Returns**: `Stylesheet` - Only if no callback is given. -##libxslt.parseFile(sourcePath, [callback]) +##libxslt.parseFile(sourcePath, callback) Parse a XSL stylesheet **Params** - sourcePath `stringPath` - The path of the file -- \[callback\] [parseFileCallback](#parseFileCallback) - The callback that handles the response. Expects err and Stylesheet object. +- callback [parseFileCallback](#parseFileCallback) - The callback that handles the response. Expects err and Stylesheet object. ##class: libxslt~Stylesheet @@ -160,7 +160,7 @@ Parse a XSL stylesheet * [class: libxslt~Stylesheet](#module_libxslt..Stylesheet) * [new libxslt~Stylesheet(stylesheetDoc, stylesheetObj)](#new_module_libxslt..Stylesheet) * [stylesheet.apply(source, [params], [callback])](#module_libxslt..Stylesheet#apply) - * [stylesheet.applyToFile(sourcePath, [params], [callback])](#module_libxslt..Stylesheet#applyToFile) + * [stylesheet.applyToFile(sourcePath, [params], callback)](#module_libxslt..Stylesheet#applyToFile) ###new libxslt~Stylesheet(stylesheetDoc, stylesheetObj) @@ -189,13 +189,13 @@ If no callback is given the function will run synchronously and return the resul **Returns**: `string` | `Document` - Only if no callback is given. Type is the same as the source param. -###stylesheet.applyToFile(sourcePath, [params], [callback]) +###stylesheet.applyToFile(sourcePath, [params], callback) Apply a stylesheet to a XML file **Params** - sourcePath `string` - The path of the file to read - \[params\] `object` - Parameters passed to the stylesheet ([http://www.w3schools.com/xsl/el_with-param.asp](http://www.w3schools.com/xsl/el_with-param.asp)) -- \[callback\] [applyToFileCallback](#Stylesheet..applyToFileCallback) - The callback that handles the response. Expects err and result as string. +- callback [applyToFileCallback](#Stylesheet..applyToFileCallback) - The callback that handles the response. Expects err and result as string. *documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown)*. \ No newline at end of file diff --git a/index.js b/index.js index 7d9d3da..b9015ad 100644 --- a/index.js +++ b/index.js @@ -62,7 +62,7 @@ exports.parse = function(source, callback) { * Parse a XSL stylesheet * * @param {stringPath} sourcePath - The path of the file - * @param {parseFileCallback} [callback] - The callback that handles the response. Expects err and Stylesheet object. + * @param {parseFileCallback} callback - The callback that handles the response. Expects err and Stylesheet object. */ exports.parseFile = function(sourcePath, callback) { fs.readFile(sourcePath, 'utf8', function(err, data){ @@ -137,7 +137,7 @@ Stylesheet.prototype.apply = function(source, params, callback) { * Callback to the Stylesheet.apply function * @callback Stylesheet~applyCallback * @param {error} [err] - Error either from parsing the XML document if given as a string or from applying the styleshet - * @param {string|Document} [result] - Result of the same type as the source param passed to apply + * @param {string|Document} [result] Result of the same type as the source param passed to apply */ /** @@ -145,7 +145,7 @@ Stylesheet.prototype.apply = function(source, params, callback) { * * @param {string} sourcePath - The path of the file to read * @param {object} [params] - Parameters passed to the stylesheet ({@link http://www.w3schools.com/xsl/el_with-param.asp}) - * @param {Stylesheet~applyToFileCallback} [callback] - The callback that handles the response. Expects err and result as string. + * @param {Stylesheet~applyToFileCallback} callback The callback that handles the response. Expects err and result as string. */ Stylesheet.prototype.applyToFile = function(sourcePath, params, callback) { var that = this;