jsduck-gen: Add --version parameter
authorTimo Tijhof <krinklemail@gmail.com>
Sat, 6 Apr 2013 01:21:37 +0000 (03:21 +0200)
committerGerrit Code Review <gerrit@wikimedia.org>
Tue, 9 Apr 2013 09:03:55 +0000 (09:03 +0000)
Follows-up I1d5b626.

Change-Id: I7a48e549e6acd2bdb7be9f6f2c34ff0554bb791c

maintenance/jsduck/config.json
maintenance/mwjsduck-gen

index c4705d8..e932b5c 100644 (file)
@@ -1,5 +1,6 @@
 {
-       "--title": "MediaWiki Code Documentation",
+       "--title": "MediaWiki core - Documentation",
+       "--footer": "Documentation for MediaWiki core. Generated on {DATE} by {JSDUCK} {VERSION}.",
        "--categories": "./categories.json",
        "--meta-tags": "./MetaTags.rb",
        "--warnings": ["-no_doc"],
@@ -15,4 +16,4 @@
                "../../resources/mediawiki.api",
                "../../resources/jquery/jquery.localize.js"
        ]
-}
\ No newline at end of file
+}
index fbd428f..cccc715 100755 (executable)
@@ -1,2 +1,17 @@
-#!/usr/bin/env sh
-jsduck --config=$(cd $(dirname $0)/..; pwd)/maintenance/jsduck/config.json && echo 'JSDuck execution finished.'
+#!/usr/bin/env bash
+
+JSDUCK_MWVERSION=master
+if [[ "$1" == "--version" && "$2" != "" ]]
+then
+       JSDUCK_MWVERSION="$2"
+elif [[ "$*" != "" ]]
+then
+       echo "Usage $0: [--version <mediawiki version>]"
+       echo
+       exit 1
+fi
+
+jsduck \
+--config=$(cd $(dirname $0)/..; pwd)/maintenance/jsduck/config.json \
+--footer="Documentation for MediaWiki core ($JSDUCK_MWVERSION). Generated on {DATE} by {JSDUCK} {VERSION}." \
+&& echo 'JSDuck execution finished.'