From 51e977de9bf101202cbcd3a1367fa07d96ff5be8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miroslav=20Bajto=C5=A1?= <miroslav@strongloop.com>
Date: Fri, 6 Jun 2014 10:28:21 +0200
Subject: [PATCH] lib/loopback: fix jsdoc comments

Use
     @property {Object} [properties]
instead of
     @property {Object=} properties
for optional properties.

Use `**example**` instead of `@example`, since strong-docs don't support
the latter.
---
 lib/loopback.js | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/lib/loopback.js b/lib/loopback.js
index d360c0e2..85c41493 100644
--- a/lib/loopback.js
+++ b/lib/loopback.js
@@ -210,7 +210,7 @@ loopback.createModel = function (name, properties, options) {
 /**
  * Create a model as described by the configuration object.
  *
- * @example
+ * **Example**
  *
  * ```js
  * loopback.createModelFromConfig({
@@ -230,8 +230,8 @@ loopback.createModel = function (name, properties, options) {
  *
  * @options {Object} model configuration
  * @property {String} name Unique name.
- * @property {Object=} properties Model properties
- * @property {Object=} options Model options. Options can be specified on the
+ * @property {Object} [properties] Model properties
+ * @property {Object} [options] Model options. Options can be specified on the
  * top level config object too. E.g. `{ base: 'User' }` is the same as
  * `{ options: { base: 'User' } }`.
  */
@@ -270,7 +270,7 @@ function buildModelOptionsFromConfig(config) {
  * @param {Model} ModelCtor The model constructor to alter.
  * @options {Object} Additional configuration to apply
  * @property {DataSource} dataSource Attach the model to a dataSource.
- * @property {Object} relations Model relations to add/update.
+ * @property {Object} [relations] Model relations to add/update.
  */
 loopback.configureModel = function(ModelCtor, config) {
   var settings = ModelCtor.settings;