@@ -81,58 +81,59 @@ export default class ViewModule extends Base {
8181 *
8282 * [bounds] initial bounds
8383 *
84- * [backgroundColor="#FFF"] - _Updatable._
84+ * @property { string } [backgroundColor="#FFF"] - _Updatable._
8585 * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
8686 * (`document.body.style.backgroundColor`),
8787 * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
8888 * areas when growing a window. Setting
8989 * this value to the anticipated content background color can help improve user experience.
9090 * Default is white.
9191 *
92- * [contentNavigation]
92+ * @property { object } [contentNavigation]
9393 * Restrict navigation to URLs that match a whitelisted pattern.
9494 * In the lack of a whitelist, navigation to URLs that match a blacklisted pattern would be prohibited.
9595 * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
96- * [contentNavigation.whitelist=[]] List of whitelisted URLs.
97- * [contentNavigation.blacklist=[]] List of blacklisted URLs.
96+ * @property { string[] } [contentNavigation.whitelist=[]] List of whitelisted URLs.
97+ * @property { string[] } [contentNavigation.blacklist=[]] List of blacklisted URLs.
9898 *
99- * [contextMenuSettings] - _Updatable._
99+ * @property { object } [contextMenuSettings] - _Updatable._
100100 * Configure the context menu when right-clicking on a view.
101- * [contextMenuSettings.enable=true] Should the context menu display on right click.
102- * [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
103- * [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
101+ * @property { boolean } [contextMenuSettings.enable=true] Should the context menu display on right click.
102+ * @property { boolean } [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
103+ * @property { boolean } [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
104104 *
105- * [customData=""] - _Updatable._
105+ * @property { any } [customData=""] - _Updatable._
106106 * A field that the user can attach serializable data to to be ferried around with the view options.
107107 * _When omitted, the default value of this property is the empty string (`""`)._
108108 *
109109 * When omitted, the default value of this property is the empty string (`""`).
110110 * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
111111 *
112- * [hotkeys=[]] - _Updatable._
112+ * @property { object[] } [hotkeys=[]] - _Updatable._
113113 * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
114114 * Within Platform, OpenFin also implements a set of pre-defined actions called
115115 * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
116116 * that can be assigned to a specific hotkey in the platform manifest.
117- * [ hotkeys.keys] The key combination of the hotkey, i.e. "Ctrl+T"
118- * [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
117+ * @property { string } hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
118+ * @property { boolean } [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
119119 *
120- * [ name]
120+ * @property { string } name
121121 * The name of the view.
122- * [preloadScripts] - _Inheritable_
122+
123+ * @property {preloadScript[] } [preloadScripts] - _Inheritable_
123124 * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
124125 * from the parent application.
125126 *
126- * [ [processAffinity=<application uuid>]
127+ * @property { string } [processAffinity=<application uuid>]
127128 * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
128129 *
129- * [target]
130+ * @property { Identity } [target]
130131 * The identity of the window this view should be attached to.
131132 *
132- * [ [url="about:blank"]
133+ * @property { string } [url="about:blank"]
133134 * The URL of the view.
134135 *
135- * [ [uuid=<application uuid>]
136+ * @property { string } [uuid=<application uuid>]
136137 * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
137138 * If omitted, defaults to the `uuid` of the application spawning the view.
138139 * If given, must match the `uuid` of the application spawning the view.
@@ -158,6 +159,7 @@ export declare class View extends WebContents<ViewEvents> {
158159 * Gets a base64 encoded image of the view or a part of it.
159160 * @function capturePage
160161 * @param { CapturePageOptions } [options] Options for the capturePage call.
162+ * @memberOf View
161163 * @instance
162164 * @return {Promise.<string> }
163165 * @tutorial View.capturePage
@@ -167,6 +169,7 @@ export declare class View extends WebContents<ViewEvents> {
167169 * applications you have created.
168170 * @param { string } code JavaScript code to be executed on the view.
169171 * @function executeJavaScript
172+ * @memberOf View
170173 * @instance
171174 * @return {Promise.<void> }
172175 * @tutorial View.executeJavaScript
@@ -187,6 +190,7 @@ export declare class View extends WebContents<ViewEvents> {
187190 /**
188191 * Returns the zoom level of the view.
189192 * @function getZoomLevel
193+ * @memberOf View
190194 * @instance
191195 * @return {Promise.<number> }
192196 * @tutorial View.getZoomLevel
@@ -195,6 +199,7 @@ export declare class View extends WebContents<ViewEvents> {
195199 * Sets the zoom level of the view.
196200 * @param { number } level The zoom level
197201 * @function setZoomLevel
202+ * @memberOf View
198203 * @instance
199204 * @return {Promise.<void> }
200205 * @tutorial View.setZoomLevel
@@ -204,6 +209,7 @@ export declare class View extends WebContents<ViewEvents> {
204209 * @param { string } searchTerm Term to find in page
205210 * @param { FindInPageOptions } options Search options
206211 * @function findInPage
212+ * @memberOf View
207213 * @instance
208214 * @return {Promise.<number> }
209215 * @tutorial View.findInPage
@@ -216,6 +222,7 @@ export declare class View extends WebContents<ViewEvents> {
216222 * "keepSelection" - Translate the selection into a normal selection.<br>
217223 * "activateSelection" - Focus and click the selection node.<br>
218224 * @function stopFindInPage
225+ * @memberOf View
219226 * @instance
220227 * @return {Promise.<void> }
221228 * @tutorial View.stopFindInPage
@@ -233,27 +240,31 @@ export declare class View extends WebContents<ViewEvents> {
233240 /**
234241 * Navigates the view back one page.
235242 * @function navigateBack
243+ * @memberOf View
236244 * @instance
237245 * @return {Promise.<void> }
238246 * @tutorial View.navigateBack
239247 */
240248 /**
241249 * Navigates the view forward one page.
242250 * @function navigateForward
251+ * @memberOf View
243252 * @instance
244253 * @return {Promise.<void> }
245254 * @tutorial View.navigateForward
246255 */
247256 /**
248257 * Stops any current navigation the view is performing.
249258 * @function stopNavigation
259+ * @memberOf View
250260 * @instance
251261 * @return {Promise.<void> }
252262 * @tutorial View.stopNavigation
253263 */
254264 /**
255265 * Reloads the view current page
256266 * @function reload
267+ * @memberOf View
257268 * @instance
258269 * @return {Promise.<void> }
259270 * @tutorial View.reload
@@ -262,20 +273,23 @@ export declare class View extends WebContents<ViewEvents> {
262273 * Prints the view's web page
263274 * @param { PrintOptions } [options] Printer Options
264275 * @function print
276+ * @memberOf View
265277 * @instance
266278 * @return {Promise.<void> }
267279 * @tutorial View.print
268280 */
269281 /**
270282 * Returns an array with all system printers
271283 * @function getPrinters
284+ * @memberOf View
272285 * @instance
273286 * @return { Promise.Array.<PrinterInfo> }
274287 * @tutorial View.getPrinters
275288 */
276289 /**
277290 * Shows the Chromium Developer Tools
278291 * @function showDeveloperTools
292+ * @memberOf View
279293 * @instance
280294 * @return {Promise.<void> }
281295 * @tutorial View.showDeveloperTools
0 commit comments