Cleaning up docs. No functional changes.

Author: jleyba

javascript/node/selenium-webdriver/builder.js

@@ -47,44 +47,40 @@ function startSeleniumServer(jar) {
  * Creates new {@link webdriver.WebDriver WebDriver} instances. The environment
  * variables listed below may be used to override a builder's configuration,
  * allowing quick runtime changes.
- * <ul>
- * <li>{@code SELENIUM_BROWSER}: defines the target browser in the form
+ *
+ * - {@code SELENIUM_BROWSER}: defines the target browser in the form
  *   {@code browser[:version][:platform]}.
  *
- * <li>{@code SELENIUM_REMOTE_URL}: defines the remote URL for all builder
+ * - {@code SELENIUM_REMOTE_URL}: defines the remote URL for all builder
  *   instances. This environment variable should be set to a fully qualified
  *   URL for a WebDriver server (e.g. http://localhost:4444/wd/hub). This
  *   option always takes precedence over {@code SELENIUM_SERVER_JAR}.
  *
- * <li>{@code SELENIUM_SERVER_JAR}: defines the path to the
- * <a href="http://selenium-release.storage.googleapis.com/index.html">
- * standalone Selenium server</a> jar to use. The server will be started the
- * first time a WebDriver instance and be killed when the process exits.
- * </ul>
+ * - {@code SELENIUM_SERVER_JAR}: defines the path to the
+ *   <a href="http://selenium-release.storage.googleapis.com/index.html">
+ *   standalone Selenium server</a> jar to use. The server will be started the
+ *   first time a WebDriver instance and be killed when the process exits.
+ *
+ * Suppose you had mytest.js that created WebDriver with
  *
- * <p>Suppose you had mytest.js that created WebDriver with
- * <pre><code>
- *   var driver = new webdriver.Builder()
- *       .forBrowser('chrome')
- *       .build();
- * </code></pre>
+ *     var driver = new webdriver.Builder()
+ *         .forBrowser('chrome')
+ *         .build();
  *
  * This test could be made to use Firefox on the local machine by running with
- * {@code SELENIUM_BROWSER=firefox node mytest.js}. Rather than change the
- * code to target Google Chrome on a remote machine, you can simply set the
- * SELENIUM_BROWSER and SELENIUM_REMOTE_URL environment variables:
- * <pre><code>
- *   SELENIUM_BROWSER=chrome:36:LINUX \
- *   SELENIUM_REMOTE_URL=http://www.example.com:4444/wd/hub \
- *   node mytest.js
- * </code></pre>
+ * `SELENIUM_BROWSER=firefox node mytest.js`. Rather than change the code to
+ * target Google Chrome on a remote machine, you can simply set the
+ * `SELENIUM_BROWSER` and `SELENIUM_REMOTE_URL` environment variables:
+ *
+ *     SELENIUM_BROWSER=chrome:36:LINUX \
+ *     SELENIUM_REMOTE_URL=http://www.example.com:4444/wd/hub \
+ *     node mytest.js
+ *
+ * You could also use a local copy of the standalone Selenium server:
  *
- * <p>You could also use a local copy of the standalone Selenium server:
- * <pre><code>
- *   SELENIUM_BROWSER=chrome:36:LINUX \
- *   SELENIUM_SERVER_JAR=/path/to/selenium-server-standalone.jar \
- *   node mytest.js
- * </code></pre>
+ *     SELENIUM_BROWSER=chrome:36:LINUX \
+ *     SELENIUM_SERVER_JAR=/path/to/selenium-server-standalone.jar \
+ *     node mytest.js
  *
  * @constructor
  */
@@ -127,8 +123,8 @@ Builder.prototype.disableEnvironmentOverrides = function() {
  * specified, the builder direct all new clients to that server. If this method
  * is never called, the Builder will attempt to create all clients locally.
  *
- * <p>As an alternative to this method, you may also set the
- * {@code SELENIUM_REMOTE_URL} environment variable.
+ * As an alternative to this method, you may also set the `SELENIUM_REMOTE_URL`
+ * environment variable.
  *
  * @param {string} url The URL of a remote server to use.
  * @return {!Builder} A self reference.
@@ -176,9 +172,9 @@ Builder.prototype.getCapabilities = function() {
  * Any calls to {@link #withCapabilities} after this function will
  * overwrite these settings.
  *
- * <p>You may also define the target browser using the {@code SELENIUM_BROWSER}
+ * You may also define the target browser using the {@code SELENIUM_BROWSER}
  * environment variable. If set, this environment variable should be of the
- * form {@code browser[:[version][:platform]]}.
+ * form `browser[:[version][:platform]]`.
  *
  * @param {(string|webdriver.Browser)} name The name of the target browser;
  *     common defaults are available on the {@link webdriver.Browser} enum.

javascript/node/selenium-webdriver/index.js

@@ -52,6 +52,10 @@ exports.Command = base.require('webdriver.Command');
 exports.EventEmitter = base.require('webdriver.EventEmitter');
 
 
+/** @type {function(new: webdriver.FileDetector)} */
+exports.FileDetector = base.require('webdriver.FileDetector');
+
+
 /** @type {function(new: webdriver.Serializable)} */
 exports.Serializable = base.require('webdriver.Serializable');
 

javascript/node/selenium-webdriver/io/exec.js

@@ -22,15 +22,12 @@ var promise = require('..').promise;
 
 /**
  * A hash with configuration options for an executed command.
- * <ul>
- * <li>
- * <li>{@code args} - Command line arguments.
- * <li>{@code env} - Command environment; will inherit from the current process
- *     if missing.
- * <li>{@code stdio} - IO configuration for the spawned server process. For
- *     more information, refer to the documentation of
- *     {@code child_process.spawn}.
- * </ul>
+ *
+ * - `args` - Command line arguments.
+ * - `env` - Command environment; will inherit from the current process if
+ *     missing.
+ * - `stdio` - IO configuration for the spawned server process. For more
+ *     information, refer to the documentation of `child_process.spawn`.
  *
  * @typedef {{
  *   args: (!Array.<string>|undefined),

javascript/node/selenium-webdriver/proxy.js

@@ -14,15 +14,14 @@
 
 /**
  * @fileoverview Defines functions for configuring a webdriver proxy:
- * <pre><code>
- * var webdriver = require('selenium-webdriver'),
- *     proxy = require('selenium-webdriver/proxy');
  *
- * var driver = new webdriver.Builder()
- *     .withCapabilities(webdriver.Capabilities.chrome())
- *     .setProxy(proxy.manual({http: 'host:1234'}))
- *     .build();
- * </code></pre>
+ *     var webdriver = require('selenium-webdriver'),
+ *         proxy = require('selenium-webdriver/proxy');
+ *
+ *     var driver = new webdriver.Builder()
+ *         .withCapabilities(webdriver.Capabilities.chrome())
+ *         .setProxy(proxy.manual({http: 'host:1234'}))
+ *         .build();
  */
 
 'use strict';
@@ -46,14 +45,13 @@ exports.direct = function() {
 /**
  * Manually configures the browser proxy.  The following options are
  * supported:
- * <ul>
- * <li>{@code ftp}: Proxy host to use for FTP requests
- * <li>{@code http}: Proxy host to use for HTTP requests
- * <li>{@code https}: Proxy host to use for HTTPS requests
- * <li>{@code bypass}: A list of hosts requests should directly connect to,
+ *
+ * - `ftp`: Proxy host to use for FTP requests
+ * - `http`: Proxy host to use for HTTP requests
+ * - `https`: Proxy host to use for HTTPS requests
+ * - `bypass`: A list of hosts requests should directly connect to,
  *     bypassing any other proxies for that request. May be specified as a
  *     comma separated string, or a list of strings.
- * </ul>
  *
  * Behavior is undefined for FTP, HTTP, and HTTPS requests if the
  * corresponding key is omitted from the configuration options.

javascript/node/selenium-webdriver/remote/index.js

@@ -32,24 +32,20 @@ var _base = require('../_base'),
 
 /**
  * Configuration options for a DriverService instance.
- * <ul>
- * <li>
- * <li>{@code loopback} - Whether the service should only be accessed on this
- *     host's loopback address.
- * <li>{@code port} - The port to start the server on (must be > 0). If the
- *     port is provided as a promise, the service will wait for the promise to
- *     resolve before starting.
- * <li>{@code args} - The arguments to pass to the service. If a promise is
- *     provided, the service will wait for it to resolve before starting.
- * <li>{@code path} - The base path on the server for the WebDriver wire
- *     protocol (e.g. '/wd/hub'). Defaults to '/'.
- * <li>{@code env} - The environment variables that should be visible to the
- *     server process. Defaults to inheriting the current process's
- *     environment.
- * <li>{@code stdio} - IO configuration for the spawned server process. For
- *     more information, refer to the documentation of
- *     {@code child_process.spawn}.
- * </ul>
+ *
+ * - `loopback` - Whether the service should only be accessed on this host's
+ *     loopback address.
+ * - `port` - The port to start the server on (must be > 0). If the port is
+ *     provided as a promise, the service will wait for the promise to resolve
+ *     before starting.
+ * - `args` - The arguments to pass to the service. If a promise is provided,
+ *     the service will wait for it to resolve before starting.
+ * - `path` - The base path on the server for the WebDriver wire protocol
+ *     (e.g. '/wd/hub'). Defaults to '/'.
+ * - `env` - The environment variables that should be visible to the server
+ *     process. Defaults to inheriting the current process's environment.
+ * - `stdio` - IO configuration for the spawned server process. For more
+ *     information, refer to the documentation of `child_process.spawn`.
  *
  * @typedef {{
  *   port: (number|!webdriver.promise.Promise.<number>),
@@ -65,10 +61,10 @@ var ServiceOptions;
 /**
  * Manages the life and death of a native executable WebDriver server.
  *
- * <p>It is expected that the driver server implements the
- * <a href="http://code.google.com/p/selenium/wiki/JsonWireProtocol">WebDriver
- * Wire Protocol</a>. Furthermore, the managed server should support multiple
- * concurrent sessions, so that this class may be reused for multiple clients.
+ * It is expected that the driver server implements the
+ * [WebDriver wire protocol](http://code.google.com/p/selenium/wiki/JsonWireProtocol).
+ * Furthermore, the managed server should support multiple concurrent sessions,
+ * so that this class may be reused for multiple clients.
  *
  * @param {string} executable Path to the executable to run.
  * @param {!ServiceOptions} options Configuration options for the service.
@@ -280,21 +276,18 @@ util.inherits(SeleniumServer, DriverService);
 
 /**
  * Options for the Selenium server:
- * <ul>
- * <li>{@code port} - The port to start the server on (must be > 0). If the
- *     port is provided as a promise, the service will wait for the promise to
- *     resolve before starting.
- * <li>{@code args} - The arguments to pass to the service. If a promise is
- *     provided, the service will wait for it to resolve before starting.
- * <li>{@code jvmArgs} - The arguments to pass to the JVM. If a promise is
- *     provided, the service will wait for it to resolve before starting.
- * <li>{@code env} - The environment variables that should be visible to the
- *     server process. Defaults to inheriting the current process's
- *     environment.
- * <li>{@code stdio} - IO configuration for the spawned server process. For
- *     more information, refer to the documentation of
- *     {@code child_process.spawn}.
- * </ul>
+ *
+ * - `port` - The port to start the server on (must be > 0). If the port is
+ *     provided as a promise, the service will wait for the promise to resolve
+ *     before starting.
+ * - `args` - The arguments to pass to the service. If a promise is provided,
+ *     the service will wait for it to resolve before starting.
+ * - `jvmArgs` - The arguments to pass to the JVM. If a promise is provided,
+ *     the service will wait for it to resolve before starting.
+ * - `env` - The environment variables that should be visible to the server
+ *     process. Defaults to inheriting the current process's environment.
+ * - `stdio` - IO configuration for the spawned server process. For more
+ *     information, refer to the documentation of `child_process.spawn`.
  *
  * @typedef {{
  *   port: (number|!webdriver.promise.Promise.<number>),
@@ -311,12 +304,25 @@ SeleniumServer.Options;
 
 
 /**
+ * A {@link webdriver.FileDetector} that may be used when running
+ * against a remote
+ * [Selenium server](http://selenium-release.storage.googleapis.com/index.html).
+ *
+ * When a file path on the local machine running this script is entered with
+ * {@link webdriver.WebElement#sendKeys WebElement#sendKeys}, this file detector
+ * will transfer the specified file to the Selenium server's host; the sendKeys
+ * command will be updated to use the transfered file's path.
+ *
+ * __Note:__ This class depends on a non-standard command supported on the
+ * Java Selenium server. The file detector will fail if used with a server that
+ * only supports standard WebDriver commands (such as the ChromeDriver).
+ *
  * @constructor
  * @extends {webdriver.FileDetector}
  * @final
  */
 var FileDetector = function() {};
-util.inherits(_base.require('webdriver.FileDetector'), FileDetector);
+util.inherits(webdriver.FileDetector, FileDetector);
 
 
 /** @override */

javascript/node/selenium-webdriver/testing/assert.js

@@ -16,20 +16,17 @@
  * @fileoverview Defines a library that simplifies writing assertions against
  * promised values.
  *
- * <blockquote>
- * <hr>
- * <b>NOTE:</b> This module is considered experimental and is subject to
- * change, or removal, at any time!
- * <hr>
- * </blockquote>
+ * > <hr>
+ * > __NOTE:__ This module is considered experimental and is subject to
+ * > change, or removal, at any time!
+ * > <hr>
  *
  * Sample usage:
- * <pre><code>
- * var driver = new webdriver.Builder().build();
- * driver.get('http://www.google.com');
  *
- * assert(driver.getTitle()).equalTo('Google');
- * </code></pre>
+ *     var driver = new webdriver.Builder().build();
+ *     driver.get('http://www.google.com');
+ *
+ *     assert(driver.getTitle()).equalTo('Google');
  */
 
 var base = require('../_base'),