web - document some API

src/vs/workbench/workbench.web.api.ts

@@ -9,13 +9,33 @@ import { UriComponents } from 'vs/base/common/uri';
 import { Event } from 'vs/base/common/event';
 
 export interface IWorkbenchConstructionOptions {
+
+	/**
+	 * Experimental: the remote authority is the IP:PORT from where the workbench is served
+	 * from. It is for example being used for the websocket connections as address.
+	 */
 	remoteAuthority: string;
 
+	/**
+	 * Experimental: An endpoint to serve iframe content ("webview") from. This is required
+	 * to provide full security isolation from the workbench host.
+	 */
 	webviewEndpoint?: string;
 
+	/**
+	 * Experimental: An optional folder that is set as workspace context for the workbench.
+	 */
 	folderUri?: UriComponents;
+
+	/**
+	 * Experimental: An optional workspace that is set as workspace context for the workbench.
+	 */
 	workspaceUri?: UriComponents;
 
+	/**
+	 * Experimental: The userData namespace is used to handle user specific application
+	 * data like settings, keybindings, UI state and snippets.
+	 */
 	userData?: {
 		read(key: string): Promise<string>;
 		write(key: string, value: string): Promise<void>;
@@ -23,6 +43,12 @@ export interface IWorkbenchConstructionOptions {
 	};
 }
 
+/**
+ * Experimental: Creates the workbench with the provided options in the provided container.
+ *
+ * @param domElement the container to create the workbench in
+ * @param options for setting up the workbench
+ */
 function create(domElement: HTMLElement, options: IWorkbenchConstructionOptions): Promise<void> {
 	return main(domElement, options);
 }