jenkins-bot has submitted this change and it was merged.
Change subject: Doc: Replace "@property @type {Type}" with "@property {Type}".
......................................................................
Doc: Replace "@property @type {Type}" with "@property {Type}".
Also removed a few redundant headings in class documentation
comments. There is already an @class and it looks a bit odd in
the generated pages:
<h2>TextString</h2>
<p>TextString</p>
<p>This class provides a ...</p>
Change-Id: Ie311c6993ed02e79272dbde71f6a1bc252ef3037
---
M modules/unicodejs/unicodejs.textstring.js
M modules/ve/ce/ve.ce.BranchNode.js
M modules/ve/ce/ve.ce.Surface.js
M modules/ve/ui/dialogs/ve.ui.ContentDialog.js
M modules/ve/ui/dialogs/ve.ui.MetaDialog.js
M modules/ve/ui/tools/dropdowns/ve.ui.FormatDropdownTool.js
M modules/ve/ui/tools/ve.ui.AnnotationButtonTool.js
M modules/ve/ui/tools/ve.ui.ButtonTool.js
M modules/ve/ui/tools/ve.ui.IndentationButtonTool.js
M modules/ve/ui/tools/ve.ui.InspectorButtonTool.js
M modules/ve/ui/tools/ve.ui.ListButtonTool.js
M modules/ve/ui/ve.ui.Element.js
M modules/ve/ui/ve.ui.Inspector.js
M modules/ve/ui/ve.ui.Tool.js
M modules/ve/ui/ve.ui.Window.js
M modules/ve/ui/widgets/ve.ui.InputWidget.js
M modules/ve/ve.Surface.js
17 files changed, 21 insertions(+), 46 deletions(-)
Approvals:
Trevor Parscal: Looks good to me, approved
jenkins-bot: Verified
diff --git a/modules/unicodejs/unicodejs.textstring.js
b/modules/unicodejs/unicodejs.textstring.js
index 4bef395..b8ddf8e 100644
--- a/modules/unicodejs/unicodejs.textstring.js
+++ b/modules/unicodejs/unicodejs.textstring.js
@@ -6,8 +6,6 @@
*/
/**
- * TextString
- *
* This class provides a simple interface to fetching plain text
* from a data source. The base class reads data from a string, but
* an extended class could provide access to a more complex structure,
diff --git a/modules/ve/ce/ve.ce.BranchNode.js
b/modules/ve/ce/ve.ce.BranchNode.js
index 7838886..811dd46 100644
--- a/modules/ve/ce/ve.ce.BranchNode.js
+++ b/modules/ve/ce/ve.ce.BranchNode.js
@@ -63,8 +63,7 @@
* Inline slug template.
*
* @static
- * @property
- * @type {jQuery}
+ * @property {jQuery}
*/
ve.ce.BranchNode.$inlineSlugTemplate = $( '<span>' )
.addClass( 've-ce-slug' )
@@ -74,8 +73,7 @@
* Block slug template.
*
* @static
- * @property
- * @type {jQuery}
+ * @property {jQuery}
*/
ve.ce.BranchNode.$blockSlugTemplate =
ve.ce.BranchNode.$inlineSlugTemplate.clone().addClass(
've-ce-slugBlock' );
diff --git a/modules/ve/ce/ve.ce.Surface.js b/modules/ve/ce/ve.ce.Surface.js
index 53b2471..5d95f1a 100644
--- a/modules/ve/ce/ve.ce.Surface.js
+++ b/modules/ve/ce/ve.ce.Surface.js
@@ -92,8 +92,7 @@
* Phantom element template.
*
* @static
- * @property
- * @type {jQuery}
+ * @property {jQuery}
*/
ve.ce.Surface.static.$phantomTemplate = $( '<div>' )
.addClass( 've-ce-surface-phantom' )
@@ -106,8 +105,7 @@
* Pattern matching "normal" characters which we can let the browser handle
natively.
*
* @static
- * @property
- * @type {RegExp}
+ * @property {RegExp}
*/
ve.ce.Surface.static.textPattern = new RegExp(
'[a-zA-Z\\-_’\'‘ÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄ'
+
diff --git a/modules/ve/ui/dialogs/ve.ui.ContentDialog.js
b/modules/ve/ui/dialogs/ve.ui.ContentDialog.js
index be2f506..1a72c32 100644
--- a/modules/ve/ui/dialogs/ve.ui.ContentDialog.js
+++ b/modules/ve/ui/dialogs/ve.ui.ContentDialog.js
@@ -30,8 +30,7 @@
* Localized message for dialog title.
*
* @static
- * @property
- * @type {string}
+ * @property {string}
*/
ve.ui.ContentDialog.static.titleMessage = 'visualeditor-dialog-content-title';
diff --git a/modules/ve/ui/dialogs/ve.ui.MetaDialog.js
b/modules/ve/ui/dialogs/ve.ui.MetaDialog.js
index 4d3a063..bb88c94 100644
--- a/modules/ve/ui/dialogs/ve.ui.MetaDialog.js
+++ b/modules/ve/ui/dialogs/ve.ui.MetaDialog.js
@@ -30,8 +30,7 @@
* Localized message for dialog title.
*
* @static
- * @property
- * @type {string}
+ * @property {string}
*/
ve.ui.MetaDialog.static.titleMessage = 'visualeditor-dialog-meta-title';
diff --git a/modules/ve/ui/tools/dropdowns/ve.ui.FormatDropdownTool.js
b/modules/ve/ui/tools/dropdowns/ve.ui.FormatDropdownTool.js
index 843f76e..c1769d7 100644
--- a/modules/ve/ui/tools/dropdowns/ve.ui.FormatDropdownTool.js
+++ b/modules/ve/ui/tools/dropdowns/ve.ui.FormatDropdownTool.js
@@ -45,8 +45,7 @@
* Options given to ve.ui.DropdownTool.
*
* @static
- * @property
- * @type {Object[]}
+ * @property {Object[]}
*/
ve.ui.FormatDropdownTool.static.items = [
{
diff --git a/modules/ve/ui/tools/ve.ui.AnnotationButtonTool.js
b/modules/ve/ui/tools/ve.ui.AnnotationButtonTool.js
index b7e2e70..cdc0245 100644
--- a/modules/ve/ui/tools/ve.ui.AnnotationButtonTool.js
+++ b/modules/ve/ui/tools/ve.ui.AnnotationButtonTool.js
@@ -32,8 +32,7 @@
*
* @abstract
* @static
- * @property
- * @type {Object}
+ * @property {Object}
* @inheritable
*/
ve.ui.AnnotationButtonTool.static.annotation = { 'name': '' };
diff --git a/modules/ve/ui/tools/ve.ui.ButtonTool.js
b/modules/ve/ui/tools/ve.ui.ButtonTool.js
index 9449a2e..a4ce91b 100644
--- a/modules/ve/ui/tools/ve.ui.ButtonTool.js
+++ b/modules/ve/ui/tools/ve.ui.ButtonTool.js
@@ -63,8 +63,7 @@
*
* @abstract
* @static
- * @property
- * @type {string|Object}
+ * @property {string|Object}
* @inheritable
*/
ve.ui.ButtonTool.static.icon = '';
diff --git a/modules/ve/ui/tools/ve.ui.IndentationButtonTool.js
b/modules/ve/ui/tools/ve.ui.IndentationButtonTool.js
index 05cbd81..765de69 100644
--- a/modules/ve/ui/tools/ve.ui.IndentationButtonTool.js
+++ b/modules/ve/ui/tools/ve.ui.IndentationButtonTool.js
@@ -31,8 +31,7 @@
*
* @abstract
* @static
- * @property
- * @type {string}
+ * @property {string}
* @inheritable
*/
ve.ui.IndentationButtonTool.static.method = '';
diff --git a/modules/ve/ui/tools/ve.ui.InspectorButtonTool.js
b/modules/ve/ui/tools/ve.ui.InspectorButtonTool.js
index 6b6ab13..c67e7c1 100644
--- a/modules/ve/ui/tools/ve.ui.InspectorButtonTool.js
+++ b/modules/ve/ui/tools/ve.ui.InspectorButtonTool.js
@@ -31,8 +31,7 @@
*
* @abstract
* @static
- * @property
- * @type {string}
+ * @property {string}
* @inheritable
*/
ve.ui.InspectorButtonTool.static.inspector = '';
diff --git a/modules/ve/ui/tools/ve.ui.ListButtonTool.js
b/modules/ve/ui/tools/ve.ui.ListButtonTool.js
index 5921065..954c1ed 100644
--- a/modules/ve/ui/tools/ve.ui.ListButtonTool.js
+++ b/modules/ve/ui/tools/ve.ui.ListButtonTool.js
@@ -29,8 +29,7 @@
*
* @abstract
* @static
- * @property
- * @type {string}
+ * @property {string}
* @inheritable
*/
ve.ui.ListButtonTool.static.style = '';
diff --git a/modules/ve/ui/ve.ui.Element.js b/modules/ve/ui/ve.ui.Element.js
index 3d01262..f387c93 100644
--- a/modules/ve/ui/ve.ui.Element.js
+++ b/modules/ve/ui/ve.ui.Element.js
@@ -37,8 +37,7 @@
* HTML element name.
*
* @static
- * @property
- * @type {string}
+ * @property {string}
* @inheritable
*/
ve.ui.Element.static.tagName = 'div';
diff --git a/modules/ve/ui/ve.ui.Inspector.js b/modules/ve/ui/ve.ui.Inspector.js
index 3b7a430..82ed02b 100644
--- a/modules/ve/ui/ve.ui.Inspector.js
+++ b/modules/ve/ui/ve.ui.Inspector.js
@@ -35,8 +35,7 @@
* Pattern to use when matching against annotation type strings.
*
* @static
- * @property
- * @type {RegExp}
+ * @property {RegExp}
*/
ve.ui.Inspector.static.typePattern = new RegExp();
diff --git a/modules/ve/ui/ve.ui.Tool.js b/modules/ve/ui/ve.ui.Tool.js
index a0fc42c..958fd8a 100644
--- a/modules/ve/ui/ve.ui.Tool.js
+++ b/modules/ve/ui/ve.ui.Tool.js
@@ -47,8 +47,7 @@
*
* @abstract
* @static
- * @property
- * @type {string}
+ * @property {string}
*/
ve.ui.Tool.static.name = '';
@@ -59,8 +58,7 @@
*
* @abstract
* @static
- * @property
- * @type {string}
+ * @property {string}
*/
ve.ui.Tool.static.cssName = null;
@@ -69,8 +67,7 @@
*
* @abstract
* @static
- * @property
- * @type {string}
+ * @property {string}
*/
ve.ui.Tool.static.titleMessage = null;
diff --git a/modules/ve/ui/ve.ui.Window.js b/modules/ve/ui/ve.ui.Window.js
index 9692362..9d5fe5e 100644
--- a/modules/ve/ui/ve.ui.Window.js
+++ b/modules/ve/ui/ve.ui.Window.js
@@ -86,8 +86,7 @@
* @see ve.ui.Frame
*
* @static
- * @property
- * @type {Object}
+ * @property {Object}
*/
ve.ui.Window.static.stylesheets = [
've.ui.Frame.css',
@@ -101,8 +100,7 @@
* Symbolic name of icon.
*
* @static
- * @property
- * @type {string}
+ * @property {string}
*/
ve.ui.Window.static.icon = 'window';
@@ -110,8 +108,7 @@
* Localized message for title.
*
* @static
- * @property
- * @type {string}
+ * @property {string}
*/
ve.ui.Window.static.titleMessage = null;
diff --git a/modules/ve/ui/widgets/ve.ui.InputWidget.js
b/modules/ve/ui/widgets/ve.ui.InputWidget.js
index 8601777..85d949e 100644
--- a/modules/ve/ui/widgets/ve.ui.InputWidget.js
+++ b/modules/ve/ui/widgets/ve.ui.InputWidget.js
@@ -59,8 +59,7 @@
* HTML input type.
*
* @static
- * @property
- * @type {string}
+ * @property {string}
* @inheritable
*/
ve.ui.InputWidget.static.inputType = '';
diff --git a/modules/ve/ve.Surface.js b/modules/ve/ve.Surface.js
index b87dbe0..783983e 100644
--- a/modules/ve/ve.Surface.js
+++ b/modules/ve/ve.Surface.js
@@ -6,8 +6,6 @@
*/
/**
- * Surface.
- *
* A surface is a top-level object which contains both a surface model and a
surface view.
*
* @example
--
To view, visit https://gerrit.wikimedia.org/r/56516
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ie311c6993ed02e79272dbde71f6a1bc252ef3037
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Krinkle <[email protected]>
Gerrit-Reviewer: Trevor Parscal <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
