mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-18 19:55:55 +00:00
8f05cdbf70
Not having a description yet is fine, but they should at least be indexed as blocks so that they are searchable and listed in the jsduck generated pages. jsduck defaults to @method + name of prototype property. And it even guesses parameters sometimes. Search: \n\n([a-zA-Z\.]+\.prototype\.[a-zA-Z]+) Where: modules/ve,modules/ve-mw Where-Not: modules/ve/test Replace: \n\n/** */\n$1 Added @return in a few places where it was easy to add. Change-Id: I830c94cc7dbc261bd7a077391f930cbfff165f9d
70 lines
1.7 KiB
JavaScript
70 lines
1.7 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface MWParameterResultWidget class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Creates an ve.ui.MWParameterResultWidget object.
|
|
*
|
|
* @class
|
|
* @extends ve.ui.OptionWidget
|
|
*
|
|
* @constructor
|
|
* @param {Mixed} data Item data
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.MWParameterResultWidget = function VeUiMWParameterResultWidget( data, config ) {
|
|
// Configuration initialization
|
|
config = ve.extendObject( {}, config, { 'icon': 'parameter' } );
|
|
|
|
// Parent constructor
|
|
ve.ui.OptionWidget.call( this, data, config );
|
|
|
|
// Initialization
|
|
this.$.addClass( 've-ui-mwParameterResultWidget' );
|
|
this.setLabel( this.buildLabel() );
|
|
};
|
|
|
|
/**
|
|
* @private
|
|
* @cfg {string} icon
|
|
*/
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ui.MWParameterResultWidget, ve.ui.OptionWidget );
|
|
|
|
/* Methods */
|
|
|
|
/** */
|
|
ve.ui.MWParameterResultWidget.prototype.buildLabel = function () {
|
|
var i, len,
|
|
$label = this.$$( '<div>' )
|
|
.addClass( 've-ui-mwParameterResultWidget-label' )
|
|
.text( this.data.label ),
|
|
$names = this.$$( '<div>' )
|
|
.addClass( 've-ui-mwParameterResultWidget-names' ),
|
|
$description = this.$$( '<div>' )
|
|
.addClass( 've-ui-mwParameterResultWidget-description' )
|
|
.text( this.data.description || '' );
|
|
|
|
if ( this.data.name ) {
|
|
$names.append(
|
|
this.$$( '<span>' )
|
|
.addClass( 've-ui-mwParameterResultWidget-name' )
|
|
.text( this.data.name )
|
|
);
|
|
}
|
|
for ( i = 0, len = this.data.aliases.length; i < len; i++ ) {
|
|
$names.append(
|
|
this.$$( '<span>' )
|
|
.addClass( 've-ui-mwParameterResultWidget-name' )
|
|
.text( this.data.aliases[i] )
|
|
);
|
|
}
|
|
|
|
return $label.add( $names ).add( $description );
|
|
};
|