Skip to content

Commit 28abb6f

Browse files
codeworriorcodeworrior
committed
[INTERNAL] JSDoc: cleanup type references
Across all libraries, type references contained some typos, unqualified names instead of qualified ones, inconsistent naming of builtin types etc. This change cleans up issues that have been reported in #88 as well as some others that have been easy to fix: - fix typos - 'mixed' is not a valid synonym for 'any' - @see expects a simple reference, not a type enclosed in curly braces and no additional texts - 'int' is the only integer type, not 'integer', 'Integer' or 'sap.ui.core.Integer' - misconception about JSDoc references - static members are addressed with a dot ('Class.name' or 'namespace.name'), - instance members are addressed with a hash ('Class#name') - local references to static members have to start with '#.member' Some topics have been left out as they need further discussion: - Boolean vs. boolean (many usages, references to wrappers in general might be ok, to be analyzed / discussed e.g. String) - DomRef/DOMNode (whether to use Element or HTMLElement needs to be discussed Fixes #88 Change-Id: Iaac9b2205aef43be4f4338798b2e5f2581e19171
1 parent f9bade8 commit 28abb6f

File tree

138 files changed

+426
-409
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+426
-409
lines changed

‎src/sap.m/src/sap/m/Button.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ sap.ui.define(['jquery.sap.global', './library', 'sap/ui/core/Control', 'sap/ui/
555555
};
556556

557557
/**
558-
* @see {sap.ui.core.Control#getAccessibilityInfo}
558+
* @see sap.ui.core.Control#getAccessibilityInfo
559559
* @protected
560560
*/
561561
Button.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/CheckBox.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ sap.ui.define(['jquery.sap.global',
316316
};
317317

318318
/**
319-
* @see {sap.ui.core.Control#getAccessibilityInfo}
319+
* @see sap.ui.core.Control#getAccessibilityInfo
320320
* @protected
321321
*/
322322
CheckBox.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/ComboBoxTextField.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ sap.ui.define(['jquery.sap.global', './InputBase', './library'],
180180
};
181181

182182
/**
183-
* @see {sap.ui.core.Control#getAccessibilityInfo}
183+
* @see sap.ui.core.Control#getAccessibilityInfo
184184
* @protected
185185
*/
186186
ComboBoxTextField.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/DatePicker.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1051,7 +1051,7 @@ sap.ui.define(['jquery.sap.global', './InputBase', 'sap/ui/model/type/Date', 'sa
10511051
};
10521052

10531053
/**
1054-
* @see {sap.ui.core.Control#getAccessibilityInfo}
1054+
* @see sap.ui.core.Control#getAccessibilityInfo
10551055
* @protected
10561056
*/
10571057
DatePicker.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/DateRangeSelection.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -718,7 +718,7 @@ sap.ui.define(['jquery.sap.global', './DatePicker', './library'],
718718
};
719719

720720
/**
721-
* @see {sap.ui.core.Control#getAccessibilityInfo}
721+
* @see sap.ui.core.Control#getAccessibilityInfo
722722
* @protected
723723
*/
724724
DateRangeSelection.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/DateTimeInput.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ sap.ui.define(['jquery.sap.global', 'sap/ui/core/Control', './library', 'sap/ui/
496496
};
497497

498498
/**
499-
* @see {sap.ui.core.Control#getAccessibilityInfo}
499+
* @see sap.ui.core.Control#getAccessibilityInfo
500500
* @protected
501501
*/
502502
DateTimeInput.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/DateTimePicker.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ sap.ui.define(['jquery.sap.global', './DatePicker', 'sap/ui/model/type/Date', '.
479479
};
480480

481481
/**
482-
* @see {sap.ui.core.Control#getAccessibilityInfo}
482+
* @see sap.ui.core.Control#getAccessibilityInfo
483483
* @protected
484484
*/
485485
DateTimePicker.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/FlexBox.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ sap.ui.define(['jquery.sap.global', './FlexBoxStylingHelper', './FlexItemData',
312312
};
313313

314314
/**
315-
* @see {sap.ui.core.Control#getAccessibilityInfo}
315+
* @see sap.ui.core.Control#getAccessibilityInfo
316316
* @protected
317317
*/
318318
FlexBox.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/IconTabBar.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ sap.ui.define(['jquery.sap.global', './library', 'sap/ui/core/Control'],
500500
* @private
501501
* @param {string} sFunctionName The name of the function to be called
502502
* @param {string} sAggregationName The name of the aggregation asociated
503-
* @returns {mixed} The return type of the called function
503+
* @returns {any} The return type of the called function
504504
*/
505505
IconTabBar.prototype._callMethodInManagedObject = function (sFunctionName, sAggregationName) {
506506
var aArgs = Array.prototype.slice.call(arguments),

‎src/sap.m/src/sap/m/Image.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,7 @@ sap.ui.define(['jquery.sap.global', './library', 'sap/ui/core/Control'],
572572
};
573573

574574
/**
575-
* @see {sap.ui.core.Control#getAccessibilityInfo}
575+
* @see sap.ui.core.Control#getAccessibilityInfo
576576
* @protected
577577
*/
578578
Image.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/Input.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1697,7 +1697,7 @@ sap.ui.define(['jquery.sap.global', './Bar', './Dialog', './InputBase', './List'
16971697
* @private
16981698
* @param {string} sFunctionName the name of the function to be called
16991699
* @param {string} sAggregationName the name of the aggregation asociated
1700-
* @returns {mixed} the return type of the called function
1700+
* @returns {any} the return type of the called function
17011701
*/
17021702
Input.prototype._callMethodInManagedObject = function(sFunctionName, sAggregationName) {
17031703
var aArgs = Array.prototype.slice.call(arguments),
@@ -1816,7 +1816,7 @@ sap.ui.define(['jquery.sap.global', './Bar', './Dialog', './InputBase', './List'
18161816
};
18171817

18181818
/**
1819-
* @see {sap.ui.core.Control#getAccessibilityInfo}
1819+
* @see sap.ui.core.Control#getAccessibilityInfo
18201820
* @protected
18211821
*/
18221822
Input.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/InputBase.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -998,7 +998,7 @@ sap.ui.define(['jquery.sap.global', './library', 'sap/ui/core/Control', 'sap/ui/
998998
};
999999

10001000
/**
1001-
* @see {sap.ui.core.Control#getAccessibilityInfo}
1001+
* @see sap.ui.core.Control#getAccessibilityInfo
10021002
* @protected
10031003
*/
10041004
InputBase.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/Label.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ sap.ui.define(['jquery.sap.global', './library', 'sap/ui/core/Control', 'sap/ui/
9999
};
100100

101101
/**
102-
* @see {sap.ui.core.Control#getAccessibilityInfo}
102+
* @see sap.ui.core.Control#getAccessibilityInfo
103103
* @protected
104104
*/
105105
Label.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/LightBoxItem.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ sap.ui.define([
145145
* Sets the source of the image.
146146
* @public
147147
* @param {sap.ui.core.URI} sImageSrc The image URI
148-
* @returns {LightBoxItem} Pointer to the control instance for chaining.
148+
* @returns {sap.m.LightBoxItem} Pointer to the control instance for chaining.
149149
*/
150150
LightBoxItem.prototype.setImageSrc = function(sImageSrc) {
151151
var oImage = this.getAggregation("_image"),
@@ -171,7 +171,7 @@ sap.ui.define([
171171
* Sets the alt text of the image.
172172
* @public
173173
* @param {string} sAlt The alt text
174-
* @returns {LightBoxItem} Pointer to the control instance for chaining.
174+
* @returns {sap.m.LightBoxItem} Pointer to the control instance for chaining.
175175
*/
176176
LightBoxItem.prototype.setAlt = function (sAlt) {
177177
var oImage = this.getAggregation("_image");
@@ -186,7 +186,7 @@ sap.ui.define([
186186
* Sets the title of the image.
187187
* @public
188188
* @param {string} sTitle The image title
189-
* @returns {LightBoxItem} Pointer to the control instance for chaining.
189+
* @returns {sap.m.LightBoxItem} Pointer to the control instance for chaining.
190190
*/
191191
LightBoxItem.prototype.setTitle = function (sTitle) {
192192
var oTitle = this.getAggregation("_title");
@@ -201,7 +201,7 @@ sap.ui.define([
201201
* Sets the subtitle of the image.
202202
* @public
203203
* @param {string} sSubtitle The image subtitle
204-
* @returns {LightBoxItem} Pointer to the control instance for chaining.
204+
* @returns {sap.m.LightBoxItem} Pointer to the control instance for chaining.
205205
*/
206206
LightBoxItem.prototype.setSubtitle = function (sSubtitle) {
207207
var oSubtitle = this.getAggregation("_subtitle");

‎src/sap.m/src/sap/m/Link.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ sap.ui.define(['jquery.sap.global', './library', 'sap/ui/core/Control', 'sap/ui/
360360
};
361361

362362
/**
363-
* @see {sap.ui.core.Control#getAccessibilityInfo}
363+
* @see sap.ui.core.Control#getAccessibilityInfo
364364
* @protected
365365
*/
366366
Link.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/MenuButton.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ sap.ui.define(['jquery.sap.global', './library', 'sap/ui/core/Control', './Butto
188188
/**
189189
* Sets the <code>buttonМode</code> of the control.
190190
* @param {sap.m.MenuButtonMode} sMode The new button mode
191-
* @returns {MenuButton} This instance
191+
* @returns {sap.m.MenuButton} This instance
192192
* @public
193193
*/
194194
MenuButton.prototype.setButtonMode = function(sMode) {

‎src/sap.m/src/sap/m/MenuItem.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ sap.ui.define(['jquery.sap.global', './library', 'sap/ui/core/Item'],
7777
/**
7878
* The new property value.
7979
*/
80-
propertyValue: {type: "mixed"}
80+
propertyValue: {type: "any"}
8181
}
8282
},
8383

‎src/sap.m/src/sap/m/MultiComboBox.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2626,7 +2626,7 @@ sap.ui.define(['jquery.sap.global', './Bar', './InputBase', './ComboBoxBase', '.
26262626
};
26272627

26282628
/**
2629-
* @see {sap.ui.core.Control#getAccessibilityInfo}
2629+
* @see sap.ui.core.Control#getAccessibilityInfo
26302630
* @protected
26312631
*/
26322632
MultiComboBox.prototype.getAccessibilityInfo = function() {

‎src/sap.m/src/sap/m/MultiInput.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1494,7 +1494,7 @@ sap.ui.define(['jquery.sap.global', './Input', './Token', './library', 'sap/ui/c
14941494

14951495

14961496
/**
1497-
* @see {sap.ui.core.Control#getAccessibilityInfo}
1497+
* @see sap.ui.core.Control#getAccessibilityInfo
14981498
* @protected
14991499
*/
15001500
MultiInput.prototype.getAccessibilityInfo = function() {

0 commit comments

Comments
 (0)