From 9ceabba9fe5ccbe0c69cb7f30cf9dd25eab52287 Mon Sep 17 00:00:00 2001 From: thiemowmde Date: Fri, 4 Oct 2024 11:07:58 +0200 Subject: [PATCH] Update JSDocs related to the reference re-use dialog Bug: T375053 Change-Id: I69a5caa8de730328ce4b5e2f92d9e04dcc576b6d --- modules/ve-cite/ve.ui.MWReferenceResultWidget.js | 9 ++++++--- modules/ve-cite/ve.ui.MWReferenceSearchWidget.js | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/modules/ve-cite/ve.ui.MWReferenceResultWidget.js b/modules/ve-cite/ve.ui.MWReferenceResultWidget.js index 63c31d42b..e06659229 100644 --- a/modules/ve-cite/ve.ui.MWReferenceResultWidget.js +++ b/modules/ve-cite/ve.ui.MWReferenceResultWidget.js @@ -12,9 +12,12 @@ * * @constructor * @extends OO.ui.OptionWidget - * @param {Object} config Configuration options - * @param {Object} config.item Result item - * @param {Object} config.reuseMenu + * @param {Object} config + * @param {Object} config.item An item from the search index in ve.ui.MWReferenceSearchWidget + * @param {ve.dm.MWReferenceModel} config.item.reference + * @param {string} config.item.name + * @param {string} config.item.footnoteLabel e.g. "note 1" + * @param {OO.ui.Element} [config.reuseMenu] */ ve.ui.MWReferenceResultWidget = function VeUiMWReferenceResultWidget( config ) { config = ve.extendObject( { diff --git a/modules/ve-cite/ve.ui.MWReferenceSearchWidget.js b/modules/ve-cite/ve.ui.MWReferenceSearchWidget.js index 42315ca4f..c37d5dbd9 100644 --- a/modules/ve-cite/ve.ui.MWReferenceSearchWidget.js +++ b/modules/ve-cite/ve.ui.MWReferenceSearchWidget.js @@ -207,8 +207,8 @@ ve.ui.MWReferenceSearchWidget.prototype.isIndexEmpty = function () { /** * @private - * @return {OO.ui.Toolbar} * @param {ve.dm.MWReferenceModel} ref + * @return {OO.ui.ButtonMenuSelectWidget} */ ve.ui.MWReferenceSearchWidget.prototype.buildReuseOptionsMenu = function ( ref ) { // TODO: Select the row on menu button click, so we don't have to wire ref