[JSDoc] Add namespace docs

WTD-1482.

platform/commonUI/about/src/AboutController.js

@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+
+/**
+ * Implements Open MCT Web's About dialog.
+ * @namespace platform/commonUI/about
+ */
 define(
     [],
     function () {

platform/commonUI/browse/src/BrowseController.js

@@ -22,7 +22,8 @@
 /*global define,Promise*/
 
 /**
- * Module defining BrowseController. Created by vwoeltje on 11/7/14.
+ * This bundle implements Browse mode.
+ * @namespace platform/commonUI/browse
  */
 define(
     [],

platform/commonUI/dialog/src/DialogService.js

@@ -22,7 +22,9 @@
 /*global define*/
 
 /**
- * Module defining DialogService. Created by vwoeltje on 11/10/14.
+ * This bundle implements the dialog service, which can be used to
+ * launch dialogs for user input & notifications.
+ * @namespace platform/commonUI/dialog
  */
 define(
     [],

platform/commonUI/edit/src/controllers/EditController.js

@@ -22,7 +22,8 @@
 /*global define,Promise*/
 
 /**
- * Module defining EditController. Created by vwoeltje on 11/14/14.
+ * This bundle implements Edit mode.
+ * @namespace platform/commonUI/edit
  */
 define(
     ["../objects/EditableDomainObject"],

platform/commonUI/general/src/StyleSheetLoader.js

@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle provides various general-purpose UI elements, including
+ * platform styling.
+ * @namespace platform/commonUI/general
+ */
 define(
     [],
     function () {

platform/commonUI/inspect/src/InfoConstants.js

@@ -20,6 +20,13 @@
  * at runtime from the About dialog for additional information.
  *****************************************************************************/
 /*global define*/
+
+/**
+ * This bundle provides support for object inspection (specifically, metadata
+ * show in bubbles on hover.)
+ * @namespace platform/commonUI/inspect
+ */
+
 define({
     BUBBLE_TEMPLATE: "<mct-container key=\"bubble\" " +
                 "bubble-title=\"{{bubbleTitle}}\" " +

platform/containment/src/CompositionPolicy.js

@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements "containment" rules, which determine which objects
+ * can be contained within which other objects.
+ * @namespace platform/containment
+ */
 define(
     ['./ContainmentTable'],
     function (ContainmentTable) {

platform/core/src/objects/DomainObjectProvider.js

@@ -22,7 +22,9 @@
 /*global define,Promise*/
 
 /**
- * Module defining DomainObjectProvider. Created by vwoeltje on 11/7/14.
+ * This bundle implements core components of Open MCT Web's service
+ * infrastructure and information model.
+ * @namespace platform/core
  */
 define(
     ["./DomainObject"],

platform/entanglement/src/services/LocationService.js

@@ -22,6 +22,11 @@
 
 /*global define */
 
+/**
+ * This bundle implements actions which control the location of objects
+ * (move, copy, link.)
+ * @namespace platform/entanglement
+ */
 define(
     function () {
         "use strict";

platform/execution/src/WorkerService.js

@@ -21,6 +21,12 @@
  *****************************************************************************/
 /*global define*/
 
+
+/**
+ * This bundle contains services for managing the flow of execution,
+ * such as support for running web workers on background threads.
+ * @namespace platform/execution
+ */
 define(
     [],
     function () {

platform/features/events/src/EventListController.js

@@ -21,11 +21,16 @@
  *****************************************************************************/
 /*global define*/
 
-/**
+/*
  * Module defining EventListController. 
  * Created by chacskaylo on 06/18/2015. 
  * Modified by shale on 06/23/2015.
  */
+
+/**
+ * This bundle implements the "Events" view of string telemetry.
+ * @namespace platform/features/events
+ */
 define(
     ["./DomainColumn", "./RangeColumn", "./EventListPopulator"],
     function (DomainColumn, RangeColumn, EventListPopulator) {

platform/features/imagery/src/controllers/ImageryController.js

@@ -21,6 +21,10 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements views of image telemetry.
+ * @namespace platform/features/imagery
+ */
 define(
     ['moment'],
     function (moment) {

platform/features/layout/src/LayoutController.js

@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements object types and associated views for
+ * display-building.
+ * @namespace platform/features/layout
+ */
 define(
     ['./LayoutDrag'],
     function (LayoutDrag) {

platform/features/pages/src/EmbeddedPageController.js

@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle adds the Web Page object type, which can be used to embed
+ * other web pages with layouts.
+ * @namespace platform/features/pages
+ */
 define(
     [],
     function () {

platform/features/plot/src/PlotController.js

@@ -22,7 +22,8 @@
 /*global define*/
 
 /**
- * Module defining PlotController. Created by vwoeltje on 11/12/14.
+ * This bundle adds a "Plot" view for numeric telemetry data.
+ * @namespace platform/features/plot
  */
 define(
     [

platform/features/scrolling/src/ScrollingListController.js

@@ -22,7 +22,8 @@
 /*global define,Promise*/
 
 /**
- * Module defining ListController. Created by vwoeltje on 11/18/14.
+ * This bundle implements a "Scrolling List" view of telemetry data.
+ * @namespace platform/features/scrolling
  */
 define(
     ["./NameColumn", "./DomainColumn", "./RangeColumn", "./ScrollingListPopulator"],

platform/forms/src/MCTForm.js

@@ -22,7 +22,9 @@
 /*global define,Promise*/
 
 /**
- * Module defining MCTForm. Created by vwoeltje on 11/10/14.
+ * This bundle implements directives for displaying and handling forms for
+ * user input.
+ * @namespace platform/forms
  */
 define(
     ["./controllers/FormController"],

platform/framework/src/Main.js

@@ -32,6 +32,11 @@ requirejs.config({
     }
 });
 
+/**
+ * Implements the framework layer, which handles the loading of bundles
+ * and the wiring-together of the extensions they expose.
+ * @namespace platform/framework
+ */
 define(
     [
         'require',

platform/persistence/cache/src/CachingPersistenceDecorator.js

@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle decorates the persistence service to maintain a local cache
+ * of persisted documents.
+ * @namespace platform/persistence/cache
+ */
 define(
     [],
     function () {

platform/persistence/couch/src/CouchPersistenceProvider.js

@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements a persistence service which uses CouchDB to
+ * store documents.
+ * @namespace platform/persistence/cache
+ */
 define(
     ["./CouchDocument"],
     function (CouchDocument) {

platform/persistence/elastic/src/ElasticPersistenceProvider.js

@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements a persistence service which uses ElasticSearch to
+ * store documents.
+ * @namespace platform/persistence/elastic
+ */
 define(
     [],
     function () {

platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js

@@ -22,7 +22,10 @@
 /*global define,Promise*/
 
 /**
- * Module defining CoreCapabilityProvider. Created by vwoeltje on 11/7/14.
+ * This bundle decorates the persistence service to handle persistence
+ * in batches, and to provide notification of persistence errors in batches
+ * as well.
+ * @namespace platform/persistence/queue
  */
 define(
     ['./QueuingPersistenceCapability'],

platform/policy/src/PolicyProvider.js

@@ -21,6 +21,10 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements the policy service.
+ * @namespace platform/policy
+ */
 define(
     [],
     function () {

platform/representation/src/MCTRepresentation.js

@@ -22,7 +22,9 @@
 /*global define,Promise*/
 
 /**
- * Module defining MCTRepresentation. Created by vwoeltje on 11/7/14.
+ * This bundle implements the directives for representing domain objects
+ * as Angular-managed HTML.
+ * @namespace platform/representation
  */
 define(
     [],

platform/representation/src/gestures/GestureConstants.js

@@ -30,7 +30,6 @@ 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.GestureConstants
      */
     MCT_DRAG_TYPE: 'mct-domain-object-id',

platform/telemetry/src/TelemetryAggregator.js

@@ -22,7 +22,9 @@
 /*global define*/
 
 /**
- * Module defining TelemetryProvider. Created by vwoeltje on 11/12/14.
+ * This bundle provides infrastructure and utility services for handling
+ * telemetry data.
+ * @namespace platform/telemetry
  */
 define(
     [],