Skip to content

Commit 1e99d93

Browse files
Cfeusiermportuga
authored andcommitted
Change doc comments - 'RowSorter' to 'rowSorter' (#5633)
docs(rowSorter): Fixed documentation reference of 'RowSorter' to be 'rowSorter' When glancing at docs, the module is displayed as 'RowSorter'. Users (like myself) might try to inject `RowSorter` instead of `rowSorter`, with resulting DI errors and frustration.
1 parent a81e5d5 commit 1e99d93

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

src/js/core/services/rowSorter.js

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ var module = angular.module('ui.grid');
44

55
/**
66
* @ngdoc object
7-
* @name ui.grid.class:RowSorter
8-
* @description RowSorter provides the default sorting mechanisms,
7+
* @name ui.grid.class:rowSorter
8+
* @description rowSorter provides the default sorting mechanisms,
99
* including guessing column types and applying appropriate sort
1010
* algorithms
1111
*
@@ -32,7 +32,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
3232

3333
/**
3434
* @ngdoc method
35-
* @methodOf ui.grid.class:RowSorter
35+
* @methodOf ui.grid.class:rowSorter
3636
* @name guessSortFn
3737
* @description Assigns a sort function to use based on the itemType in the column
3838
* @param {string} itemType one of 'number', 'boolean', 'string', 'date', 'object'. And
@@ -61,7 +61,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
6161

6262
/**
6363
* @ngdoc method
64-
* @methodOf ui.grid.class:RowSorter
64+
* @methodOf ui.grid.class:rowSorter
6565
* @name handleNulls
6666
* @description Sorts nulls and undefined to the bottom (top when
6767
* descending). Called by each of the internal sorters before
@@ -92,7 +92,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
9292

9393
/**
9494
* @ngdoc method
95-
* @methodOf ui.grid.class:RowSorter
95+
* @methodOf ui.grid.class:rowSorter
9696
* @name basicSort
9797
* @description Sorts any values that provide the < method, including strings
9898
* or numbers. Handles nulls and undefined through calling handleNulls
@@ -118,7 +118,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
118118

119119
/**
120120
* @ngdoc method
121-
* @methodOf ui.grid.class:RowSorter
121+
* @methodOf ui.grid.class:rowSorter
122122
* @name sortNumber
123123
* @description Sorts numerical values. Handles nulls and undefined through calling handleNulls
124124
* @param {object} a sort value a
@@ -137,7 +137,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
137137

138138
/**
139139
* @ngdoc method
140-
* @methodOf ui.grid.class:RowSorter
140+
* @methodOf ui.grid.class:rowSorter
141141
* @name sortNumberStr
142142
* @description Sorts numerical values that are stored in a string (i.e. parses them to numbers first).
143143
* Handles nulls and undefined through calling handleNulls
@@ -191,7 +191,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
191191

192192
/**
193193
* @ngdoc method
194-
* @methodOf ui.grid.class:RowSorter
194+
* @methodOf ui.grid.class:rowSorter
195195
* @name sortAlpha
196196
* @description Sorts string values. Handles nulls and undefined through calling handleNulls
197197
* @param {object} a sort value a
@@ -213,7 +213,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
213213

214214
/**
215215
* @ngdoc method
216-
* @methodOf ui.grid.class:RowSorter
216+
* @methodOf ui.grid.class:rowSorter
217217
* @name sortDate
218218
* @description Sorts date values. Handles nulls and undefined through calling handleNulls.
219219
* Handles date strings by converting to Date object if not already an instance of Date
@@ -242,7 +242,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
242242

243243
/**
244244
* @ngdoc method
245-
* @methodOf ui.grid.class:RowSorter
245+
* @methodOf ui.grid.class:rowSorter
246246
* @name sortBool
247247
* @description Sorts boolean values, true is considered larger than false.
248248
* Handles nulls and undefined through calling handleNulls
@@ -271,7 +271,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
271271

272272
/**
273273
* @ngdoc method
274-
* @methodOf ui.grid.class:RowSorter
274+
* @methodOf ui.grid.class:rowSorter
275275
* @name getSortFn
276276
* @description Get the sort function for the column. Looks first in
277277
* rowSorter.colSortFnCache using the column name, failing that it
@@ -331,7 +331,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
331331

332332
/**
333333
* @ngdoc method
334-
* @methodOf ui.grid.class:RowSorter
334+
* @methodOf ui.grid.class:rowSorter
335335
* @name prioritySort
336336
* @description Used where multiple columns are present in the sort criteria,
337337
* we determine which column should take precedence in the sort by sorting
@@ -384,7 +384,7 @@ module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGr
384384
*/
385385
/**
386386
* @ngdoc method
387-
* @methodOf ui.grid.class:RowSorter
387+
* @methodOf ui.grid.class:rowSorter
388388
* @name sort
389389
* @description sorts the grid
390390
* @param {Object} grid the grid itself

0 commit comments

Comments
 (0)