Skip to content

Commit 0805f81

Browse files
committed
working around jsdoc bugs
1 parent a0c6bb7 commit 0805f81

File tree

5 files changed

+28
-4
lines changed

5 files changed

+28
-4
lines changed

Diff for: README.md

+1
Original file line numberDiff line numberDiff line change
@@ -152,3 +152,4 @@ For use with `.recognizeBlob({play: true})` - slows the results down to match th
152152
* consider renaming recognizeBlob to recognizeFile to make the usage more obvious
153153
* consider an `interim` event for recognize/format/timing streams to avoid objectMode (in most cases)
154154
* ajax / playFile demo
155+
* fix documentation generation

Diff for: dist/watson-speech.js

+12-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: index.js

+11
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,19 @@
33

44
'use strict';
55

6+
/**
7+
* @namespace WatsonSpeech
8+
*/
9+
10+
/**
11+
* Version - for public releases, this should have the version number, e.g 'v1.0.0'
12+
*/
613
exports.version = process.env.TRAVIS_BRANCH;
714

15+
/**
16+
* SpeechToText
17+
* @type {*|exports|module.exports}
18+
*/
819
exports.SpeechToText = require('./speech-to-text');
920

1021
// todo: add text-to-speech

Diff for: jsdoc/config.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
{
22
"source": {
3-
"include": [ "./", "speech-to-text/" ]
3+
"include": [ "./index.js", "./speech-to-text/" ]
44
},
5-
"options": {
5+
"note": "at some point, the options param was apparently renamed to opts",
6+
"opts": {
67
"package": "package.json",
78
"readme": "README.md",
89
"recurse": false,

Diff for: package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"minify": "with-package uglifyjs --compress --mangle --screw-ie8 dist/watson-speech.js --output dist/watson-speech.min.js --preamble \"// IBM Watson Speech JavaScript SDK\n// vpkg.version\n// Generated at `date`\n// Copyright IBM (pkg.license)\"",
1313
"watchify": "watchify index.js --standalone WatsonSpeech --outfile dist/watson-speech.js --debug --verbose",
1414
"build": "npm run browserify && npm run minify",
15-
"doc": "jsdoc -c jsdoc/config.json",
15+
"doc": "jsdoc -c jsdoc/config.json --debug",
1616
"watch-doc": "nodemon --watch lib/ --watch services/ --watch jsdoc/ --watch package.json --ext js,tmpl --exec npm run doc"
1717
},
1818
"author": "Nathan Friedly <http://nfriedly.com>",

0 commit comments

Comments
 (0)