Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
albanm committed Sep 11, 2014
1 parent 6625be0 commit 024aa85
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<a name="module_libxslt.parse"></a>
##libxslt.parse(source, [callback])
Expand All @@ -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.
<a name="module_libxslt.parseFile"></a>
##libxslt.parseFile(sourcePath, [callback])
##libxslt.parseFile(sourcePath, callback)
Parse a XSL stylesheet

**Params**

- sourcePath `stringPath` - The path of the file
- \[callback\] <code>[parseFileCallback](#parseFileCallback)</code> - The callback that handles the response. Expects err and Stylesheet object.
- callback <code>[parseFileCallback](#parseFileCallback)</code> - The callback that handles the response. Expects err and Stylesheet object.

<a name="module_libxslt..Stylesheet"></a>
##class: libxslt~Stylesheet
Expand All @@ -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)

<a name="new_module_libxslt..Stylesheet"></a>
###new libxslt~Stylesheet(stylesheetDoc, stylesheetObj)
Expand Down Expand Up @@ -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.
<a name="module_libxslt..Stylesheet#applyToFile"></a>
###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\] <code>[applyToFileCallback](#Stylesheet..applyToFileCallback)</code> - The callback that handles the response. Expects err and result as string.
- callback <code>[applyToFileCallback](#Stylesheet..applyToFileCallback)</code> - The callback that handles the response. Expects err and result as string.

*documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown)*.
6 changes: 3 additions & 3 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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){
Expand Down Expand Up @@ -137,15 +137,15 @@ 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
*/

/**
* Apply a stylesheet to a XML file
*
* @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;
Expand Down

0 comments on commit 024aa85

Please sign in to comment.