ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-02-09 04:11:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[API] Add metadata to View jsdoc

Browse Source
This commit is contained in:
Victor Woeltjen 2016-09-06 09:14:04 -07:00
parent c9b1035a6d
commit 4739b36bc3
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/api/View.js
View File

@ -4,7 +4,8 @@ define([], function () {
* A View is used to provide displayable content, and to react to * A View is used to provide displayable content, and to react to
* associated life cycle events. * associated life cycle events.
* *
* @class * @interface
* @memberof module:openmct
*/ */
function View() { function View() {
@ -18,6 +19,8 @@ define([], function () {
* the contents of this view up-to-date. * the contents of this view up-to-date.
* *
* @param {HTMLElement} container the DOM element to populate * @param {HTMLElement} container the DOM element to populate
* @method show
* @memberof module:openmct.View#
*/ */
View.prototype.show = function (container) { View.prototype.show = function (container) {
@ -29,6 +32,9 @@ define([], function () {
* View implementations should use this method to detach any * View implementations should use this method to detach any
* listeners or release other resources that are no longer necessary * listeners or release other resources that are no longer necessary
* once a view is no longer used. * once a view is no longer used.
*
* @method destroy
* @memberof module:openmct.View#
*/ */
View.prototype.destroy = function () { View.prototype.destroy = function () {