Add js docs to public properties and methods #3

bower.json

@@ -8,7 +8,7 @@
     "paper-dialog-scrollable": "PolymerElements/paper-dialog-scrollable#^2.0.0"
   },
   "devDependencies": {
-    "iron-component-page": "PolymerElements/iron-component-page#^2.0.0",
+    "iron-component-page": "PolymerElements/iron-component-page#^3.0.0",
     "iron-demo-helpers": "PolymerElements/iron-demo-helpers#^2.0.0",
     "web-component-tester": "^6.0.0",
     "webcomponentsjs": "webcomponents/webcomponentsjs#^1.0.0"

cuba-entity-edit-view-behavior.html

@@ -3,11 +3,39 @@
    * @polymerBehavior CubaEntityEditViewBehavior
    */
   CubaEntityEditViewBehavior = {
+
+    /**
+     * Fired when an entity successfully saved.
+     *
+     * @event commit
+     */
+
+    /**
+     * Fired when user cancels changes.
+     *
+     * @event cancel
+     */
+
+    /**
+     * Fired when when user deletes an entity.
+     *
+     * @event delete
+     * @param {Object} entity The entity to delete
+     */
+
     properties: {
+      /**
+       * Id of entity that will be loaded
+       */
       entityId: {
         type: String,
         observer: '_handleEntityIdChange'
       },
+      /**
+       * Loaded entity
+       *
+       * @type {Object}
+       */
       entity: {
         type: Object,
         value: function() {

cuba-entity-list-view-behavior.html

@@ -4,30 +4,69 @@
    */
   CubaEntityListViewBehavior = {
 
+    /**
+     * Fired when user taps on item.
+     *
+     * @event item-tap
+     */
+
     properties: {
+      /**
+       * Indicates if data is loading
+       */
       active: {
         type: Boolean,
         value: false
       },
+      /**
+       * Loaded entities
+       *
+       * @type {Array<Object>}
+       */
       entities: Array,
+      /**
+       * Number of entities
+       */
       entitiesCount: Number,
+      /**
+       * Indicates if more data is available
+       */
       moreDataAvailable: {
         type: Boolean,
         computed: '_computeMoreDataAvailable(entities, entitiesCount, entities.*)',
         value: false
       },
+      /**
+       * Indicates if data is currently loading
+       */
       dataLoading: {
         type: Boolean,
         notify: true
       },
+      /**
+       * Entity that is currently selected
+       *
+       * @type {Object}
+       */
       selectedEntity: {
         type: Object,
         notify: true
       }
     },
+    /**
+     * Reloads entities
+     *
+     * @return {Promise}
+     */
     reload: function() {
       return this.$.data.load();
     },
+    /**
+     * Removes entity
+     *
+     * @param {Object} entity The entity to remove
+     * @return {Promise}
+     */
     remove: function(entity) {
       return this.$.data.remove(entity);
     },

cuba-lookup.html

@@ -68,6 +68,8 @@
       properties: {
         /**
          * Entity which has been picked by user.
+         *
+         * @type {Object}
          */
         pickedEntity: {
           type: Object,
@@ -76,6 +78,8 @@
 
         /**
          * Entity which is currently selected in lookup dialog.
+         *
+         * @type {Object}
          */
         selectedEntity: {
           type: Object,
@@ -93,6 +97,11 @@
           }.bind(this));
         }
       },
+      /**
+       * Shows lookup screen
+       *
+       * @return {void}
+       */
       showLookupScreen: function() {
         this._lookupElement.reload().then(function() {
           this.$.lookupDialog.open();

cuba-progress-indicator.html

@@ -72,7 +72,7 @@
        *
        * ### Styling
        *
-       * `<cuba-progress-indicator>` provides the following custom properties and mixins
+       * `<cuba-progress-indicator>` provides the following custom properties
        * for styling:
        *
        * Custom property | Description | Default

cuba-ui.html

@@ -1,3 +1,4 @@
 <link rel="import" href="cuba-lookup.html"/>
+<link rel="import" href="cuba-progress-indicator.html"/>
 <link rel="import" href="cuba-entity-list-view-behavior.html"/>
 <link rel="import" href="cuba-entity-edit-view-behavior.html"/>

index.html

@@ -9,6 +9,6 @@
     <link rel="import" href="../iron-component-page/iron-component-page.html">
   </head>
   <body>
-    <iron-component-page src="cuba-ui.html"></iron-component-page>
+    <iron-component-page></iron-component-page>
   </body>
 </html>