build: Provide jsduck to build JS-land documentation

Change-Id: I8d24398e23e1c8f57183a32bcf9fdf8795e5543f
This commit is contained in:
James D. Forrester 2016-04-22 12:47:47 -07:00 committed by Matthew Flaschen
parent a23a878953
commit e690a5b9f9
3 changed files with 15 additions and 2 deletions

1
.gitignore vendored
View file

@ -1 +1,2 @@
node_modules
docs

12
jsduck.json Normal file
View file

@ -0,0 +1,12 @@
{
"--title": "Thanks - Documentation",
"--output": "docs",
"--processes": "0",
"--warnings-exit-nonzero": true,
"--builtin-classes": true,
"--external": "jQuery.Promise",
"--warnings": ["-nodoc(class,public)", "-global"],
"--": [
"modules"
]
}

View file

@ -73,8 +73,8 @@
/**
* Initialise a thank button in the given container.
*
* @param {jQuery.Object} $user existing element with data attributes associated describing a user.
* @param {jQuery.Object} $container to render button in
* @param {jQuery} $user existing element with data attributes associated describing a user.
* @param {jQuery} $container to render button in
*/
function init( $user, $container ) {
var username = $user.data( 'user-name' ),