From 3b69eaebcd73f6da3170aa0c1c9fc4fe73bf358b Mon Sep 17 00:00:00 2001
From: Chris M
Date: Sat, 18 May 2013 12:23:06 -0300
Subject: docs(ngMock::$log): improve the `$log.*.logs` descriptions
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.
---
src/ngMock/angular-mocks.js | 32 ++++++++++++++++++++++++++++----
1 file changed, 28 insertions(+), 4 deletions(-)
(limited to 'src/ngMock/angular-mocks.js')
diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js
index 62b66576..07673802 100644
--- a/src/ngMock/angular-mocks.js
+++ b/src/ngMock/angular-mocks.js
@@ -322,7 +322,13 @@ angular.mock.$LogProvider = function() {
* @propertyOf ngMock.$log
*
* @description
- * Array of logged messages.
+ * Array of messages logged using {@link ngMock.$log#log}.
+ *
+ * @example
+ *
+ * $log.log('Some Log');
+ * var first = $log.log.logs.unshift();
+ *
*/
$log.log.logs = [];
/**
@@ -331,7 +337,13 @@ angular.mock.$LogProvider = function() {
* @propertyOf ngMock.$log
*
* @description
- * Array of logged messages.
+ * Array of messages logged using {@link ngMock.$log#warn}.
+ *
+ * @example
+ *
+ * $log.warn('Some Warning');
+ * var first = $log.warn.logs.unshift();
+ *
*/
$log.warn.logs = [];
/**
@@ -340,7 +352,13 @@ angular.mock.$LogProvider = function() {
* @propertyOf ngMock.$log
*
* @description
- * Array of logged messages.
+ * Array of messages logged using {@link ngMock.$log#info}.
+ *
+ * @example
+ *
+ * $log.info('Some Info');
+ * var first = $log.info.logs.unshift();
+ *
*/
$log.info.logs = [];
/**
@@ -349,7 +367,13 @@ angular.mock.$LogProvider = function() {
* @propertyOf ngMock.$log
*
* @description
- * Array of logged messages.
+ * Array of messages logged using {@link ngMock.$log#error}.
+ *
+ * @example
+ *
+ * $log.log('Some Error');
+ * var first = $log.error.logs.unshift();
+ *
*/
$log.error.logs = [];
};
--
cgit v1.2.3