Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-05-09 23:34:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(ngMock::$log): improve the $log.*.logs descriptions

Browse source 
Because ngDoc generation only takes the last segment of a property name,
each $log.[error|warn|log...].logs property has the same name and is
confusing in the docs.
This commit helps this by adding a link to the $log.* method and also an
appropriate usage example.
This commit is contained in:
Chris M 2013-05-18 12:23:06 -03:00 committed by Pete Bacon Darwin
parent 86cbdb893a
commit 84daf33c03
1 changed files with 28 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
src/ngMock/angular-mocks.js vendored
View file

@ -322,7 +322,13 @@ angular.mock.$LogProvider = function() {
* @propertyOf ngMock.$log * @propertyOf ngMock.$log
* *
* @description * @description
* Array of logged messages. * Array of messages logged using {@link ngMock.$log#log}.
*
* @example
* <pre>
* $log.log('Some Log');
* var first = $log.log.logs.unshift();
* </pre>
*/ */
$log.log.logs = []; $log.log.logs = [];
/** /**
@ -331,7 +337,13 @@ angular.mock.$LogProvider = function() {
* @propertyOf ngMock.$log * @propertyOf ngMock.$log
* *
* @description * @description
* Array of logged messages. * Array of messages logged using {@link ngMock.$log#warn}.
*
* @example
* <pre>
* $log.warn('Some Warning');
* var first = $log.warn.logs.unshift();
* </pre>
*/ */
$log.warn.logs = []; $log.warn.logs = [];
/** /**
@ -340,7 +352,13 @@ angular.mock.$LogProvider = function() {
* @propertyOf ngMock.$log * @propertyOf ngMock.$log
* *
* @description * @description
* Array of logged messages. * Array of messages logged using {@link ngMock.$log#info}.
*
* @example
* <pre>
* $log.info('Some Info');
* var first = $log.info.logs.unshift();
* </pre>
*/ */
$log.info.logs = []; $log.info.logs = [];
/** /**
@ -349,7 +367,13 @@ angular.mock.$LogProvider = function() {
* @propertyOf ngMock.$log * @propertyOf ngMock.$log
* *
* @description * @description
* Array of logged messages. * Array of messages logged using {@link ngMock.$log#error}.
*
* @example
* <pre>
* $log.log('Some Error');
* var first = $log.error.logs.unshift();
* </pre>
*/ */
$log.error.logs = []; $log.error.logs = [];
}; };