Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/198281
Change subject: FieldLayout: Clarify description and mark private methods
......................................................................
FieldLayout: Clarify description and mark private methods
Change-Id: Ic359784bd5de7bf622567741bfde3282d6f9c11c
---
M src/layouts/FieldLayout.js
1 file changed, 6 insertions(+), 3 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/81/198281/1
diff --git a/src/layouts/FieldLayout.js b/src/layouts/FieldLayout.js
index 0d50dbd..8638574 100644
--- a/src/layouts/FieldLayout.js
+++ b/src/layouts/FieldLayout.js
@@ -25,8 +25,9 @@
* @constructor
* @param {OO.ui.Widget} fieldWidget Field widget
* @param {Object} [config] Configuration options
- * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top'
or 'inline'
- * @cfg {string} [help] Explanatory text shown as a '?' icon.
+ * @cfg {string} [align='left'] Alignment of the label: 'left', 'right', 'top'
or 'inline'
+ * @cfg {string} [help] Help text. When help text is specified, a help icon
will appear
+ * in the upper-right corner of the rendered field.
*/
OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) {
// Allow passing positional parameters inside the config object
@@ -97,6 +98,7 @@
/**
* Handle field disable events.
*
+ * @private
* @param {boolean} value Field is disabled
*/
OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) {
@@ -106,6 +108,7 @@
/**
* Handle label mouse click events.
*
+ * @private
* @param {jQuery.Event} e Mouse click event
*/
OO.ui.FieldLayout.prototype.onLabelClick = function () {
@@ -114,7 +117,7 @@
};
/**
- * Get the field.
+ * Get the widget contained by the field.
*
* @return {OO.ui.Widget} Field widget
*/
--
To view, visit https://gerrit.wikimedia.org/r/198281
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ic359784bd5de7bf622567741bfde3282d6f9c11c
Gerrit-PatchSet: 1
Gerrit-Project: oojs/ui
Gerrit-Branch: master
Gerrit-Owner: Kmenger <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
