Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/211287
Change subject: ToolGroupFactory: Add description
......................................................................
ToolGroupFactory: Add description
Change-Id: I43379a24347fc6fa685b98d901dde6a02e69c1ae
---
M src/ToolGroupFactory.js
1 file changed, 13 insertions(+), 2 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/87/211287/1
diff --git a/src/ToolGroupFactory.js b/src/ToolGroupFactory.js
index 109b86e..98d07ba 100644
--- a/src/ToolGroupFactory.js
+++ b/src/ToolGroupFactory.js
@@ -1,6 +1,17 @@
/**
- * Factory for tool groups.
+ * ToolGroupFactories create {@link OO.ui.ToolGroup toolgroups} on demand. The
toolgroup classes must
+ * specify a symbolic name and be registered with the factory. The following
classes are registered by
+ * default:
*
+ * - {@link OO.ui.BarToolGroup BarToolGroups} (‘bar’)
+ * - {@link OO.ui.MenuToolGroup MenuToolGroups} (‘menu’)
+ * - {@link OO.ui.ListToolGroup ListToolGroups} (‘list’)
+ *
+ * See {@link OO.ui.Toolbar toolbars} for an example.
+ *
+ * For more information about toolbars in general, please see the [OOjs UI
documentation on MediaWiki][1].
+ *
+ * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
* @class
* @extends OO.Factory
* @constructor
@@ -25,7 +36,7 @@
/* Static Methods */
/**
- * Get a default set of classes to be registered on construction
+ * Get a default set of classes to be registered on construction.
*
* @return {Function[]} Default classes
*/
--
To view, visit https://gerrit.wikimedia.org/r/211287
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I43379a24347fc6fa685b98d901dde6a02e69c1ae
Gerrit-PatchSet: 1
Gerrit-Project: oojs/ui
Gerrit-Branch: master
Gerrit-Owner: Kmenger <kmen...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
