Skip to content

docs(core): Fixes event callback documentation #4143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2015
Merged

docs(core): Fixes event callback documentation #4143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/js/core/factories/Grid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,13 +378,15 @@ angular.module('ui.grid')
* getColumnSorting, which is an array of gridColumns
* that have sorting on them, sorted in priority order.
*
* @param {Grid} grid the grid
* @param {array} sortColumns an array of columns with
* sorts on them, in priority order
* @param {$scope} The scope of the controller. This is used to deregister this event when the scope is destroyed.
* @param {Function} callBack Will be called when the event is emited. The function passes back an array of columns with
* sorts on them, in priority order.
*
* @example
* <pre>
* gridApi.core.on.sortChanged( grid, sortColumns );
* gridApi.core.on.sortChanged( $scope, function(sortColumns){
* // do something
* });
* </pre>
*/
self.api.registerEvent( 'core', 'sortChanged' );
Expand All @@ -395,8 +397,9 @@ angular.module('ui.grid')
* @methodOf ui.grid.core.api:PublicApi
* @description The visibility of a column has changed,
* the column itself is passed out as a parameter of the event.
*
* @param {GridCol} column the column that changed
*
* @param {$scope} The scope of the controller. This is used to deregister this event when the scope is destroyed.
* @param {Function} callBack Will be called when the event is emited. The function passes back the GridCol that has changed.
*
* @example
* <pre>
Expand Down