Add documentation for the actions.

adopted-ember-addons · Sep 1, 2016 · c998182 · c998182
1 parent 889f76c
commit c998182
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/addon/components/x-select.js b/addon/components/x-select.js
@@ -168,11 +168,28 @@ export default Ember.Component.extend({
   })),
 
   actions: {
+
+    /**
+     * Registers a new option that is contained within x-select.
+     *
+     * This is called whenever an x-option component is inserted into the DOM.
+     *
+     * @param {<x-option>} option - x-option component.
+     * @private
+     */
     registerOption(option) {
       this.get('options').push(option);
       this._setDefaultValues();
     },
 
+    /**
+     * Removes a the passed option that is contained within x-select.
+     *
+     * This is called whenever an x-option component is begining teardown.
+     *
+     * @param {<x-option>} option - x-option component.
+     * @private
+     */
     unregisterOption(option) {
       this.get('options').removeObject(option);
       this._setDefaultValues();