Skip to content

Commit

Permalink
Configuration beans link in documentation
Browse files Browse the repository at this point in the history
Few configuration beans were incorrectly referred to by the API
documentation (using a dot instead of a colon). Fixed for beans
called CfgBeans.
  • Loading branch information
Mathieu Bruyen committed Mar 9, 2015
1 parent 315c6a9 commit 817d3a5
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions src/aria/resources/handlers/LCRangeResourceHandler.js
Expand Up @@ -63,7 +63,7 @@ var ariaUtilsType = require("../../utils/Type");
* Call the callback with an array of suggestions in its arguments. Suggestions that are exact match are
* marked with parameter exactMatch set to true.
* @param {String} textEntry Search string
* @param {aria.core.CfgBeans.Callback} callback Called when suggestions are ready
* @param {aria.core.CfgBeans:Callback} callback Called when suggestions are ready
*/
getSuggestions : function (textEntry, callback) {
if (!typesUtil.isString(textEntry) || textEntry.length < this.threshold) {
Expand Down Expand Up @@ -112,7 +112,7 @@ var ariaUtilsType = require("../../utils/Type");
/**
* Internal method to call LCResourcesHandler
* @param {String} textEntry Search string
* @param {aria.core.CfgBeans.Callback} callback Called when suggestions are ready
* @param {aria.core.CfgBeans:Callback} callback Called when suggestions are ready
* @private
*/
__getSuggestion : function (textEntry, callback) {
Expand Down
2 changes: 1 addition & 1 deletion src/aria/touch/widgets/Popup.js
Expand Up @@ -36,7 +36,7 @@ module.exports = Aria.classDefinition({
},
/**
* Popup Constructor.
* @param {aria.touch.widgets.PopupCfgBeans.PopupCfg} cfg popup configuration
* @param {aria.touch.widgets.PopupCfgBeans:PopupCfg} cfg popup configuration
* @param {aria.templates.TemplateCtxt} context template context
* @param {Number} lineNumber line number in the template
*/
Expand Down
4 changes: 2 additions & 2 deletions src/aria/widgets/calendar/CalendarController.js
Expand Up @@ -23,8 +23,8 @@ var ariaCoreJsonValidator = require("../../core/JsonValidator");

/**
* Function to sort ranges by fromDate.
* @param {aria.widgets.calendar.CfgBeans.Range} a
* @param {aria.widgets.calendar.CfgBeans.Range} b
* @param {aria.widgets.calendar.CfgBeans:Range} a
* @param {aria.widgets.calendar.CfgBeans:Range} b
* @return {Number} Returns -1 if a.fromDate < b.fromDate, 0 if a.fromDate == b.fromDate, and 1 if a.fromDate >
* b.fromDate
*/
Expand Down
2 changes: 1 addition & 1 deletion src/aria/widgets/calendar/ICalendarController.js
Expand Up @@ -121,7 +121,7 @@ module.exports = Aria.interfaceDefinition({
/**
* Return information about the position of the given JavaScript date in the calendar data model.
* @param {Date} JavaScript date
* @return {aria.widgets.calendar.CfgBeans.DatePosition} position of the date in the calendar data model, or
* @return {aria.widgets.calendar.CfgBeans:DatePosition} position of the date in the calendar data model, or
* null if the date cannot be found in the current calendar data model.
*/
getDatePosition : function (jsDate) {},
Expand Down
2 changes: 1 addition & 1 deletion src/aria/widgets/form/TextInput.js
Expand Up @@ -33,7 +33,7 @@ module.exports = Aria.classDefinition({
$css : [ariaWidgetsFormTextInputStyle],
/**
* TextInput constructor
* @param {aria.widgets.CfgBeans.TextInputCfg} cfg the widget configuration
* @param {aria.widgets.CfgBeans:TextInputCfg} cfg the widget configuration
* @param {aria.templates.TemplateCtxt} ctxt template context
* @param {Number} lineNumber Line number corresponding in the .tpl file where the widget is created
* @param {aria.widgets.controller.TextDataController} controller the data controller object
Expand Down
2 changes: 1 addition & 1 deletion src/aria/widgets/form/Textarea.js
Expand Up @@ -31,7 +31,7 @@ module.exports = Aria.classDefinition({
},
/**
* Textarea constructor
* @param {aria.widgets.CfgBeans.TextareaCfg} cfg the widget configuration
* @param {aria.widgets.CfgBeans:TextareaCfg} cfg the widget configuration
* @param {aria.templates.TemplateCtxt} ctxt template context
* @param {Number} lineNumber Line number corresponding in the .tpl file where the widget is created
*/
Expand Down
2 changes: 1 addition & 1 deletion src/aria/widgets/form/TimeField.js
Expand Up @@ -26,7 +26,7 @@ module.exports = Aria.classDefinition({
$extends : ariaWidgetsFormTextInput,
/**
* TimeField constructor
* @param{aria.widgets.CfgBeans.TimeFieldCfg} cfg the widget configuration
* @param{aria.widgets.CfgBeans:TimeFieldCfg} cfg the widget configuration
* @param{aria.templates.TemplateCtxt} ctxt template context
* @param {Number} lineNumber Line number corresponding in the .tpl file where the widget is created
*/
Expand Down
4 changes: 2 additions & 2 deletions src/aria/widgets/form/list/ListController.js
Expand Up @@ -310,7 +310,7 @@ module.exports = Aria.classDefinition({

/**
* Set the items property.
* @param {aria.widgets.form.list.CfgBeans.ItemsArray} newItems array of items
* @param {aria.widgets.form.list.CfgBeans:ItemsArray} newItems array of items
* @protected
*/
_setItems : function (newItems) {
Expand Down Expand Up @@ -474,7 +474,7 @@ module.exports = Aria.classDefinition({

/**
* Set the items property.
* @param {aria.widgets.form.list.CfgBeans.Items} newItems
* @param {aria.widgets.form.list.CfgBeans:Items} newItems
*/
setItems : function (newItems) {
var res = this._mergeItemsAndSelectionInfo(newItems, this.getSelectedValues());
Expand Down
2 changes: 1 addition & 1 deletion src/aria/widgets/form/list/templates/ListTemplateScript.js
Expand Up @@ -63,7 +63,7 @@ module.exports = Aria.tplScriptDefinition({
/**
* Called after a refresh. This method adds a timer callback to change scrollbar position for the selected item
* to be displayed (if there is only one item selected).
* @param {aria.templates.CfgBeans.RefreshCfg} args arguments given for the refresh
* @param {aria.templates.CfgBeans:RefreshCfg} args arguments given for the refresh
*/
$afterRefresh : function (args) {
var sectionId = args ? args.section : null;
Expand Down

0 comments on commit 817d3a5

Please sign in to comment.