[JSDoc] Add annotations

Bulk-add JSDoc annotations, WTD-1482.

platform/representation/src/MCTInclude.js

@@ -49,6 +49,7 @@ define(
          *   an output) and `parameters` is meant to be useful for
          *   display parameterization (more like an input.)
          *
+         * @memberof platform/representation
          * @constructor
          * @param {TemplateDefinition[]} templates an array of
          *        template extensions
@@ -92,3 +93,4 @@ define(
         return MCTInclude;
     }
 );
+

platform/representation/src/MCTRepresentation.js

@@ -47,6 +47,7 @@ define(
          * * `parameters`, used to communicate display parameters to
          *   the included template (e.g. title.)
          *
+         * @memberof platform/representation
          * @constructor
          * @param {RepresentationDefinition[]} representations an array of
          *        representation extensions
@@ -238,3 +239,4 @@ define(
         return MCTRepresentation;
     }
 );
+

platform/representation/src/actions/ContextMenuAction.js

@@ -39,6 +39,7 @@ define(
         /**
          * Launches a custom context menu for the domain object it contains.
          *
+         * @memberof platform/representation
          * @constructor
          * @param $compile Angular's $compile service
          * @param $document the current document
@@ -113,4 +114,4 @@ define(
 
         return ContextMenuAction;
     }
-);
+);

platform/representation/src/gestures/ContextMenuGesture.js

@@ -33,6 +33,7 @@ define(
          * Add listeners to a representation such that it calls the
          * context menu action for the domain object it contains.
          *
+         * @memberof platform/representation
          * @constructor
          * @param element the jqLite-wrapped element which should exhibit
          *                the context mennu
@@ -54,6 +55,7 @@ define(
                  * Detach any event handlers associated with this gesture.
                  * @method
                  * @memberof ContextMenuGesture
+                 * @memberof platform/representation.ContextMenuGesture#
                  */
                 destroy: function () {
                     element.off('contextmenu', stop);
@@ -63,4 +65,4 @@ define(
 
         return ContextMenuGesture;
     }
-);
+);

platform/representation/src/gestures/DragGesture.js

@@ -33,6 +33,7 @@ define(
          * Add event handlers to a representation such that it may be
          * dragged as the source for drag-drop composition.
          *
+         * @memberof platform/representation
          * @constructor
          * @param $log Angular's logging service
          * @param element the jqLite-wrapped element which should become
@@ -108,6 +109,7 @@ define(
                  * Detach any event handlers associated with this gesture.
                  * @memberof DragGesture
                  * @method
+                 * @memberof platform/representation.DragGesture#
                  */
                 destroy: function () {
                     // Detach listener
@@ -120,4 +122,4 @@ define(
 
         return DragGesture;
     }
-);
+);

platform/representation/src/gestures/DropGesture.js

@@ -33,6 +33,7 @@ define(
          * A DropGesture adds and maintains event handlers upon an element
          * such that it may act as a drop target for drag-drop composition.
 
+         * @memberof platform/representation
          * @constructor
          * @param $q Angular's $q, for promise handling
          * @param element the jqLite-wrapped representation element
@@ -124,6 +125,7 @@ define(
             return {
                 /**
                  * Detach any event handlers associated with this gesture.
+                 * @memberof platform/representation.DropGesture#
                  */
                 destroy: function () {
                     element.off('dragover', dragOver);
@@ -136,4 +138,4 @@ define(
 
         return DropGesture;
     }
-);
+);

platform/representation/src/gestures/GestureConstants.js

@@ -29,6 +29,8 @@ define({
      * The string identifier for the data type used for drag-and-drop
      * composition of domain objects. (e.g. in event.dataTransfer.setData
      * calls.)
+     * @constructor
+     * @memberof platform/representation
      */
     MCT_DRAG_TYPE: 'mct-domain-object-id',
     /**
@@ -46,4 +48,4 @@ define({
      * Identifier for drop events.
      */
     MCT_DROP_EVENT: 'mctDrop'
-});
+});

platform/representation/src/gestures/GestureProvider.js

@@ -40,6 +40,7 @@ define(
          * intermediary between these and the `mct-representation` directive
          * where they are used.
          *
+         * @memberof platform/representation
          * @constructor
          * @param {Gesture[]} gestures an array of all gestures which are
          *        available as extensions
@@ -100,6 +101,7 @@ define(
                  * @return {{ destroy: function }} an object with a `destroy`
                  *         method which can (and should) be used when a
                  *         gesture should no longer be applied to an element.
+                 * @memberof platform/representation.GestureProvider#
                  */
                 attachGestures: attachGestures
             };
@@ -107,4 +109,4 @@ define(
 
         return GestureProvider;
     }
-);
+);

platform/representation/src/gestures/GestureRepresenter.js

@@ -37,6 +37,8 @@ define(
          *        gestures
          * @param {Scope} scope the Angular scope for this representation
          * @param element the JQLite-wrapped mct-representation element
+         * @constructor
+         * @memberof platform/representation
          */
         function GestureRepresenter(gestureService, scope, element) {
             var gestureHandle;
@@ -69,10 +71,12 @@ define(
                  *        definition of the representation in use
                  * @param {DomainObject} domainObject the domain object
                  *        being represented
+                 * @memberof platform/representation.GestureRepresenter#
                  */
                 represent: represent,
                 /**
                  * Release any resources associated with this representer.
+                 * @memberof platform/representation.GestureRepresenter#
                  */
                 destroy: destroy
             };
@@ -80,4 +84,4 @@ define(
 
         return GestureRepresenter;
     }
-);
+);

platform/representation/src/services/DndService.js

@@ -32,6 +32,7 @@ define(
          * * Storing arbitrary JavaScript objects (not just strings.)
          * * Allowing inspection of dragged objects during `dragover` events,
          *   etc. (which cannot be done in Chrome for security reasons)
+         * @memberof platform/representation
          * @constructor
          * @param $log Angular's $log service
          */
@@ -43,6 +44,7 @@ define(
                  * Set drag data associated with a given type.
                  * @param {string} key the type's identiifer
                  * @param {*} value the data being dragged
+                 * @memberof platform/representation.DndService#
                  */
                 setData: function (key, value) {
                     $log.debug("Setting drag data for " + key);
@@ -51,6 +53,7 @@ define(
                 /**
                  * Get drag data associated with a given type.
                  * @returns {*} the data being dragged
+                 * @memberof platform/representation.DndService#
                  */
                 getData: function (key) {
                     return data[key];
@@ -58,6 +61,7 @@ define(
                 /**
                  * Remove data associated with active drags.
                  * @param {string} key the type to remove
+                 * @memberof platform/representation.DndService#
                  */
                 removeData: function (key) {
                     $log.debug("Clearing drag data for " + key);
@@ -68,4 +72,4 @@ define(
 
         return DndService;
     }
-);
+);