MediaWiki Examples

From 4a8a13e1814e174af34709109493498f9554280f Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Wed, 26 Jun 2013 16:33:51 -0700 Subject: [PATCH] Enable @example for jsduck index Change-Id: Ifa38338b797413b6ad54c49f508cabe21c1565ea --- maintenance/jsduck/config.json | 1 + maintenance/jsduck/eg-iframe.html | 86 +++++++++++++++++++++++++++---- maintenance/mwjsduck-gen | 6 ++- resources/mediawiki/mediawiki.js | 17 +++--- 4 files changed, 94 insertions(+), 16 deletions(-) diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json index 60522c58e9..2a40f29f3b 100644 --- a/maintenance/jsduck/config.json +++ b/maintenance/jsduck/config.json @@ -3,6 +3,7 @@ "--footer": "Documentation for MediaWiki core. Generated on {DATE} by {JSDUCK} {VERSION}.", "--categories": "./categories.json", "--meta-tags": "./MetaTags.rb", + "--eg-iframe": "./eg-iframe.html", "--warnings": ["-no_doc"], "--builtin-classes": true, "--output": "../../docs/js", diff --git a/maintenance/jsduck/eg-iframe.html b/maintenance/jsduck/eg-iframe.html index f53b40445e..86eae4b616 100644 --- a/maintenance/jsduck/eg-iframe.html +++ b/maintenance/jsduck/eg-iframe.html @@ -2,19 +2,87 @@ - MediaWiki Examples + MediaWiki Code Example + + + + + + + - - + diff --git a/maintenance/mwjsduck-gen b/maintenance/mwjsduck-gen index cccc715883..bc10bc2c7b 100755 --- a/maintenance/mwjsduck-gen +++ b/maintenance/mwjsduck-gen @@ -11,7 +11,11 @@ then exit 1 fi +MWCORE_DIR=$(cd $(dirname $0)/..; pwd) + jsduck \ ---config=$(cd $(dirname $0)/..; pwd)/maintenance/jsduck/config.json \ +--config=$MWCORE_DIR/maintenance/jsduck/config.json \ --footer="Documentation for MediaWiki core ($JSDUCK_MWVERSION). Generated on {DATE} by {JSDUCK} {VERSION}." \ && echo 'JSDuck execution finished.' + +ln -s ../../resources $MWCORE_DIR/docs/js/modules diff --git a/resources/mediawiki/mediawiki.js b/resources/mediawiki/mediawiki.js index 0d1fbb78be..8409d456c4 100644 --- a/resources/mediawiki/mediawiki.js +++ b/resources/mediawiki/mediawiki.js @@ -1648,6 +1648,17 @@ var mw = ( function ( $, undefined ) { /** * HTML construction helper functions + * + * @example + * + * var Html, output; + * + * Html = mw.html; + * output = Html.element( 'div', {}, new Html.Raw( + * Html.element( 'img', { src: '<' } ) + * ) ); + * mw.log( output ); //

+ * * @class mw.html * @singleton */ @@ -1688,12 +1699,6 @@ var mw = ( function ( $, undefined ) { * - this.Cdata: The value attribute is included, and an exception is * thrown if it contains an illegal ETAGO delimiter. * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2 - * - * Example: - * var h = mw.html; - * return h.element( 'div', {}, - * new h.Raw( h.element( 'img', {src: '<'} ) ) ); - * Returns

*/ element: function ( name, attrs, contents ) { var v, attrName, s = '<' + name; -- 2.20.1