Changes to JSdoc comments

Moved faviconFile to class properties.
This commit is contained in:
Rand McKinney 2014-11-04 10:59:38 -08:00
parent 5e5dbb4e9e
commit 0e35c1877c
1 changed files with 3 additions and 1 deletions

View File

@ -24,6 +24,8 @@ var assert = require('assert');
* @property {String} mime * @property {String} mime
* @property {Boolean} isBrowser True if running in a browser environment; false otherwise. Static read-only property. * @property {Boolean} isBrowser True if running in a browser environment; false otherwise. Static read-only property.
* @property {Boolean} isServer True if running in a server environment; false otherwise. Static read-only property. * @property {Boolean} isServer True if running in a server environment; false otherwise. Static read-only property.
* @property {String} faviconFile Path to a default favicon shipped with LoopBack.
* Use as follows: `app.use(require('serve-favicon')(loopback.faviconFile));`
* @class loopback * @class loopback
* @header loopback * @header loopback
*/ */
@ -133,7 +135,7 @@ if (loopback.isServer) {
*/ */
if (loopback.isServer) { if (loopback.isServer) {
/** /*!
* Path to a default favicon shipped with LoopBack. * Path to a default favicon shipped with LoopBack.
* *
* **Example** * **Example**