From e690a5b9f94c56262e3370faa78acae2d53f5814 Mon Sep 17 00:00:00 2001 From: "James D. Forrester" Date: Fri, 22 Apr 2016 12:47:47 -0700 Subject: [PATCH] build: Provide jsduck to build JS-land documentation Change-Id: I8d24398e23e1c8f57183a32bcf9fdf8795e5543f --- .gitignore | 1 + jsduck.json | 12 ++++++++++++ modules/ext.thanks.mobilediff.js | 4 ++-- 3 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 jsduck.json diff --git a/.gitignore b/.gitignore index 3c3629e6..1e430d8c 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ node_modules +docs diff --git a/jsduck.json b/jsduck.json new file mode 100644 index 00000000..e3919b44 --- /dev/null +++ b/jsduck.json @@ -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" + ] +} diff --git a/modules/ext.thanks.mobilediff.js b/modules/ext.thanks.mobilediff.js index 51b221af..d0843951 100644 --- a/modules/ext.thanks.mobilediff.js +++ b/modules/ext.thanks.mobilediff.js @@ -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' ),