clean up globals area of jsdoc by assigning every tag to a class
authorSteve Hackbarth <stephenhackbarth@gmail.com>
Thu, 23 Jan 2014 03:25:40 +0000 (22:25 -0500)
committerSteve Hackbarth <stephenhackbarth@gmail.com>
Thu, 23 Jan 2014 03:25:40 +0000 (22:25 -0500)
13 files changed:
lib/backbone-x/source/collection.js
lib/backbone-x/source/model.js
lib/backbone-x/source/settings.js
lib/backbone-x/source/view.js
lib/backbone-x/source/workflow.js
lib/enyo-x/source/views/grid_box.js
lib/enyo-x/source/views/list_relations_editor_box.js
lib/enyo-x/source/views/sort_popup.js
lib/enyo-x/source/views/transaction_list.js
lib/enyo-x/source/widgets/model_decorator.js
lib/enyo-x/source/widgets/parameter.js
lib/enyo-x/source/widgets/simple_model_table.js
lib/enyo-x/source/widgets/tree.js

index 44c67e9..b6e3b52 100644 (file)
@@ -28,7 +28,7 @@ white:true*/
   /**
    * @class XM.StaticModel
    */
-  XM.StaticModel = Backbone.Model.extend({
+  XM.StaticModel = Backbone.Model.extend(/** @lends XM.StaticModel# */{
     idAttribute: 'key',
 
 
index 552f106..292a52a 100644 (file)
           }
         },
 
-        /**
-         * @callback
-         * Handle successful fetch response. Obtain lock if necessary, and invoke
-         * the optional callback.
-         */
+        // Handle successful fetch response. Obtain lock if necessary, and invoke
+        // the optional callback.
         afterFetch = function (resp) {
           var schema = XT.session.getSchemas()[that.recordType.prefix()],
             lockable = schema.get(that.recordType.suffix()).lockable;
index a53bcf1..7ba8039 100644 (file)
@@ -22,10 +22,7 @@ white:true*/
       var options = _.extend({ }, _options),
         userCallback = options.success,
 
-        /**
-         * @callback
-         * Handle a dispatch response as a Backbone sync response.
-         */
+        //Handle a dispatch response as a Backbone sync response.
         done = function (model, resp, options) {
           model.set(resp, options);
           model.setStatus(XM.Model.READY_CLEAN, options);
index 16e8187..15f59f1 100644 (file)
@@ -35,7 +35,7 @@
     });
   };
 
-  XM.EnyoView = XM.View.extend(/* @lends XM.EnyoView */{
+  XM.EnyoView = XM.View.extend(/** @lends XM.EnyoView# */{
 
     item: {
       /**
@@ -54,7 +54,6 @@
       },
 
       /**
-       * @member
        * Decorations DSL for List Item. Used by Decorators; feel free to
        * override or extend. If empty, the default is used as defined by the
        * optional Decorator which wraps this List Item, if present.
@@ -76,7 +75,6 @@
 
     list: {
       /**
-       * @member
        * List which actions this list supports. 'method' and 'prerequisite'
        * are invoked on the model by default, unless 'isViewMethod' is set to
        * true.
@@ -89,7 +87,6 @@
       ],
 
       /**
-       * @member
        * Describe the query used to populate/sort the list.
        */
       query: { /** @example
     },
 
     /**
-     * @member
      * @summary Map model events to Enyo events.
      * @desc The events block is employed slightly differently and more powerfully
      * in our XM.EnyoView than in a traditional Backbone.View.
     },
 
     /**
-     * @member
-     * jQuery? More like nullQuery! So, a foo walks into a bar...
-     *
-     * Seriously, this view prefers no knowledge of any jquery-ness, and since
+     * This view prefers no knowledge of any jquery-ness, and since
      * implemented an MVP-like design, will refer to its 'el' as 'presenter'
      * instead.
      */
index 7f2664b..8502683 100644 (file)
@@ -13,8 +13,8 @@ white:true*/
 
     @extends XM.Model
   */
-  XM.Workflow = XM.Model.extend({
-    /** @scope XM.Workflow.prototype */
+  XM.Workflow = XM.Model.extend(
+    /** @lends XM.Workflow# */{
 
     // By default, the completedParentStatus and deferredParentStatus
     // values should drive a change to the status of the parent, but
@@ -156,8 +156,8 @@ white:true*/
   // Workflow status mixin
   XM.Workflow = XM.Workflow.extend(XM.WorkflowStatus);
 
-  _.extend(XM.Workflow, {
-     /** @scope XM.Workflow */
+  _.extend(XM.Workflow,
+    /** @lends XM.Workflow# */{
 
     /**
       Pending status for workflow.
@@ -207,7 +207,7 @@ white:true*/
     @extends XM.Model
   */
   XM.WorkflowSource = XM.Model.extend(
-    /** @scope XM.WorkflowSource.prototype */ {
+    /** @lends XM.WorkflowSource# */ {
 
     defaults: function () {
       return {
index c838758..5fed09d 100644 (file)
@@ -138,7 +138,7 @@ trailing:true, white:true, strict: false*/
     @see XV.RelationsEditor.
   */
   var editor = enyo.mixin({}, XV.RelationsEditorMixin);
-  editor = enyo.mixin(editor, {
+  editor = enyo.mixin(editor, /** @lends XV.GridEditor */{
     name: "XV.GridEditor",
     classes: "xv-grid-row selected",
     published: {
index 24792f7..aef862a 100644 (file)
@@ -17,9 +17,6 @@ trailing:true, white:true, strict: false*/
     handlers: {
       onValueChange: "controlValueChanged"
     },
-    /**
-    @todo Document the destroy method.
-    */
     destroy: function () {
       if (this.value) {
         this.value.off(_events, this.attributesChanged, this);
@@ -28,9 +25,6 @@ trailing:true, white:true, strict: false*/
       this.value = null;
       this.inherited(arguments);
     },
-    /**
-    @todo Document the setValue method.
-    */
     setValue: function (value) {
       if (this.value) {
         this.value.off(_events, this.attributesChanged, this);
index 5077bed..2e83db3 100644 (file)
@@ -5,7 +5,8 @@ trailing:true, white:true*/
 
 (function () {
 
-  enyo.kind({
+  enyo.kind(
+    /** @lends XV.SortPopup# */{
     name: "XV.SortPopup",
     kind: "onyx.Popup",
     classes: "xv-sort-popup",
index 3b67a23..7ecc1a7 100644 (file)
@@ -12,7 +12,8 @@ trailing:true, white:true, strict:false*/
     @name XV.TransactionList
     @extends XV.List
    */
-  enyo.kind({
+  enyo.kind(
+    /** @lends XV.TransactionList */{
     name: "XV.TransactionList",
     kind: "XV.List",
     published: {
index 3442600..714e871 100644 (file)
@@ -40,7 +40,7 @@
     published: {
       control: null
     },
-    
+
     create: function () {
       this.inherited(arguments);
       var controls = this.getClientControls();
@@ -60,7 +60,7 @@
    * @mixes XV.ModelAttributeFormatters
    */
   enyo.kind(
-    enyo.mixin(XV.ModelAttributeFormatters, {
+    enyo.mixin(XV.ModelAttributeFormatters, /** @lends XV.ListItemDecorator# */{
 
     name: 'XV.ListItemDecorator',
     kind: 'XV.ModelDecorator',
index cc54a2b..8392d48 100644 (file)
@@ -564,7 +564,7 @@ white:true*/
 
     TODO: Move common components here from Filter and Layout forms
   */
-  enyo.kind({
+  enyo.kind(/** @lends XV.UserItemForm# */{
     name: "XV.UserItemForm",
     classes: "xv-filter-form",
     events: {
@@ -791,7 +791,7 @@ white:true*/
     User Item Form for selecting saved layouts, a save drawer for saving
     the current layout, and a manage drawer for sharing and deleting layouts.
   */
-  enyo.kind({
+  enyo.kind(/** @lends XV.LayoutForm# */{
     name: "XV.LayoutForm",
     kind: "XV.UserItemForm",
     events: {
index 065588e..0ce16bc 100644 (file)
@@ -1,6 +1,6 @@
 (function () {
 
-  enyo.kind({
+  enyo.kind(/** @lends XV.SimpleModelTable# */{
     name: 'XV.SimpleModelTable',
     published: {
       template: null
index 48ec425..8b962e1 100644 (file)
@@ -9,7 +9,8 @@ regexp:true, undef:true, trailing:true, white:true */
     @class A control that allows for building a hierarchial view
     @extends FittableRows
    */
-  enyo.kind({
+  enyo.kind(
+    /** @lends XV.Tree# */{
     name: "XV.Tree",
     kind: "FittableRows",
     fit: true,