docs: fix broken class links, format details and usage (#1536)

Author: yury-s

playwright/src/main/java/com/microsoft/playwright/APIRequest.java

@@ -23,14 +23,14 @@
 /**
  * Exposes API that can be used for the Web API testing. This class is used for creating {@code APIRequestContext} instance
  * which in turn can be used for sending web requests. An instance of this class can be obtained via {@link
- * Playwright#request Playwright.request()}. For more information see {@code APIRequestContext}.
+ * com.microsoft.playwright.Playwright#request Playwright.request()}. For more information see {@code APIRequestContext}.
  */
 public interface APIRequest {
   class NewContextOptions {
     /**
-     * Methods like {@link APIRequestContext#get APIRequestContext.get()} take the base URL into consideration by using the <a
-     * href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL">{@code URL()}</a> constructor for building the
-     * corresponding URL. Examples:
+     * Methods like {@link com.microsoft.playwright.APIRequestContext#get APIRequestContext.get()} take the base URL into
+     * consideration by using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL">{@code URL()}</a>
+     * constructor for building the corresponding URL. Examples:
      * <ul>
      * <li> baseURL: {@code http://localhost:3000} and sending request to {@code /bar.html} results in {@code
      * http://localhost:3000/bar.html}</li>
@@ -60,16 +60,17 @@ class NewContextOptions {
     public Proxy proxy;
     /**
      * Populates context with given storage state. This option can be used to initialize context with logged-in information
-     * obtained via {@link BrowserContext#storageState BrowserContext.storageState()} or {@link APIRequestContext#storageState
-     * APIRequestContext.storageState()}. Either a path to the file with saved storage, or the value returned by one of {@link
-     * BrowserContext#storageState BrowserContext.storageState()} or {@link APIRequestContext#storageState
+     * obtained via {@link com.microsoft.playwright.BrowserContext#storageState BrowserContext.storageState()} or {@link
+     * com.microsoft.playwright.APIRequestContext#storageState APIRequestContext.storageState()}. Either a path to the file
+     * with saved storage, or the value returned by one of {@link com.microsoft.playwright.BrowserContext#storageState
+     * BrowserContext.storageState()} or {@link com.microsoft.playwright.APIRequestContext#storageState
      * APIRequestContext.storageState()} methods.
      */
     public String storageState;
     /**
      * Populates context with given storage state. This option can be used to initialize context with logged-in information
-     * obtained via {@link BrowserContext#storageState BrowserContext.storageState()}. Path to the file with saved storage
-     * state.
+     * obtained via {@link com.microsoft.playwright.BrowserContext#storageState BrowserContext.storageState()}. Path to the
+     * file with saved storage state.
      */
     public Path storageStatePath;
     /**
@@ -83,9 +84,9 @@ class NewContextOptions {
     public String userAgent;
 
     /**
-     * Methods like {@link APIRequestContext#get APIRequestContext.get()} take the base URL into consideration by using the <a
-     * href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL">{@code URL()}</a> constructor for building the
-     * corresponding URL. Examples:
+     * Methods like {@link com.microsoft.playwright.APIRequestContext#get APIRequestContext.get()} take the base URL into
+     * consideration by using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL">{@code URL()}</a>
+     * constructor for building the corresponding URL. Examples:
      * <ul>
      * <li> baseURL: {@code http://localhost:3000} and sending request to {@code /bar.html} results in {@code
      * http://localhost:3000/bar.html}</li>
@@ -143,9 +144,10 @@ public NewContextOptions setProxy(Proxy proxy) {
     }
     /**
      * Populates context with given storage state. This option can be used to initialize context with logged-in information
-     * obtained via {@link BrowserContext#storageState BrowserContext.storageState()} or {@link APIRequestContext#storageState
-     * APIRequestContext.storageState()}. Either a path to the file with saved storage, or the value returned by one of {@link
-     * BrowserContext#storageState BrowserContext.storageState()} or {@link APIRequestContext#storageState
+     * obtained via {@link com.microsoft.playwright.BrowserContext#storageState BrowserContext.storageState()} or {@link
+     * com.microsoft.playwright.APIRequestContext#storageState APIRequestContext.storageState()}. Either a path to the file
+     * with saved storage, or the value returned by one of {@link com.microsoft.playwright.BrowserContext#storageState
+     * BrowserContext.storageState()} or {@link com.microsoft.playwright.APIRequestContext#storageState
      * APIRequestContext.storageState()} methods.
      */
     public NewContextOptions setStorageState(String storageState) {
@@ -154,8 +156,8 @@ public NewContextOptions setStorageState(String storageState) {
     }
     /**
      * Populates context with given storage state. This option can be used to initialize context with logged-in information
-     * obtained via {@link BrowserContext#storageState BrowserContext.storageState()}. Path to the file with saved storage
-     * state.
+     * obtained via {@link com.microsoft.playwright.BrowserContext#storageState BrowserContext.storageState()}. Path to the
+     * file with saved storage state.
      */
     public NewContextOptions setStorageStatePath(Path storageStatePath) {
       this.storageStatePath = storageStatePath;

playwright/src/main/java/com/microsoft/playwright/APIRequestContext.java

@@ -24,21 +24,23 @@
  * environment or the service to your e2e test.
  *
  * <p> Each Playwright browser context has associated with it {@code APIRequestContext} instance which shares cookie storage
- * with the browser context and can be accessed via {@link BrowserContext#request BrowserContext.request()} or {@link
- * Page#request Page.request()}. It is also possible to create a new APIRequestContext instance manually by calling {@link
- * APIRequest#newContext APIRequest.newContext()}.
+ * with the browser context and can be accessed via {@link com.microsoft.playwright.BrowserContext#request
+ * BrowserContext.request()} or {@link com.microsoft.playwright.Page#request Page.request()}. It is also possible to create
+ * a new APIRequestContext instance manually by calling {@link com.microsoft.playwright.APIRequest#newContext
+ * APIRequest.newContext()}.
  *
- * <p> **Cookie management**
+ * <p> <strong>Cookie management</strong>
  *
- * <p> {@code APIRequestContext} returned by {@link BrowserContext#request BrowserContext.request()} and {@link Page#request
- * Page.request()} shares cookie storage with the corresponding {@code BrowserContext}. Each API request will have {@code
- * Cookie} header populated with the values from the browser context. If the API response contains {@code Set-Cookie}
- * header it will automatically update {@code BrowserContext} cookies and requests made from the page will pick them up.
- * This means that if you log in using this API, your e2e test will be logged in and vice versa.
+ * <p> {@code APIRequestContext} returned by {@link com.microsoft.playwright.BrowserContext#request BrowserContext.request()}
+ * and {@link com.microsoft.playwright.Page#request Page.request()} shares cookie storage with the corresponding {@code
+ * BrowserContext}. Each API request will have {@code Cookie} header populated with the values from the browser context. If
+ * the API response contains {@code Set-Cookie} header it will automatically update {@code BrowserContext} cookies and
+ * requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be
+ * logged in and vice versa.
  *
  * <p> If you want API requests to not interfere with the browser cookies you should create a new {@code APIRequestContext} by
- * calling {@link APIRequest#newContext APIRequest.newContext()}. Such {@code APIRequestContext} object will have its own
- * isolated cookie storage.
+ * calling {@link com.microsoft.playwright.APIRequest#newContext APIRequest.newContext()}. Such {@code APIRequestContext}
+ * object will have its own isolated cookie storage.
  */
 public interface APIRequestContext {
   class StorageStateOptions {
@@ -79,9 +81,10 @@ default APIResponse delete(String url) {
    */
   APIResponse delete(String url, RequestOptions params);
   /**
-   * All responses returned by {@link APIRequestContext#get APIRequestContext.get()} and similar methods are stored in the
-   * memory, so that you can later call {@link APIResponse#body APIResponse.body()}.This method discards all its resources,
-   * calling any method on disposed {@code APIRequestContext} will throw an exception.
+   * All responses returned by {@link com.microsoft.playwright.APIRequestContext#get APIRequestContext.get()} and similar
+   * methods are stored in the memory, so that you can later call {@link com.microsoft.playwright.APIResponse#body
+   * APIResponse.body()}.This method discards all its resources, calling any method on disposed {@code APIRequestContext}
+   * will throw an exception.
    *
    * @since v1.16
    */
@@ -91,7 +94,7 @@ default APIResponse delete(String url) {
    * context cookies from the response. The method will automatically follow redirects. JSON objects can be passed directly
    * to the request.
    *
-   * <p> **Usage**
+   * <p> <strong>Usage</strong>
    * <pre>{@code
    * Map<String, Object> data = new HashMap();
    * data.put("title", "Book Title");
@@ -127,7 +130,7 @@ default APIResponse fetch(String urlOrRequest) {
    * context cookies from the response. The method will automatically follow redirects. JSON objects can be passed directly
    * to the request.
    *
-   * <p> **Usage**
+   * <p> <strong>Usage</strong>
    * <pre>{@code
    * Map<String, Object> data = new HashMap();
    * data.put("title", "Book Title");
@@ -162,7 +165,7 @@ default APIResponse fetch(String urlOrRequest) {
    * context cookies from the response. The method will automatically follow redirects. JSON objects can be passed directly
    * to the request.
    *
-   * <p> **Usage**
+   * <p> <strong>Usage</strong>
    * <pre>{@code
    * Map<String, Object> data = new HashMap();
    * data.put("title", "Book Title");
@@ -198,7 +201,7 @@ default APIResponse fetch(Request urlOrRequest) {
    * context cookies from the response. The method will automatically follow redirects. JSON objects can be passed directly
    * to the request.
    *
-   * <p> **Usage**
+   * <p> <strong>Usage</strong>
    * <pre>{@code
    * Map<String, Object> data = new HashMap();
    * data.put("title", "Book Title");
@@ -233,7 +236,7 @@ default APIResponse fetch(Request urlOrRequest) {
    * response. The method will populate request cookies from the context and update context cookies from the response. The
    * method will automatically follow redirects.
    *
-   * <p> **Usage**
+   * <p> <strong>Usage</strong>
    *
    * <p> Request parameters can be configured with {@code params} option, they will be serialized into the URL search parameters:
    * <pre>{@code
@@ -253,7 +256,7 @@ default APIResponse get(String url) {
    * response. The method will populate request cookies from the context and update context cookies from the response. The
    * method will automatically follow redirects.
    *
-   * <p> **Usage**
+   * <p> <strong>Usage</strong>
    *
    * <p> Request parameters can be configured with {@code params} option, they will be serialized into the URL search parameters:
    * <pre>{@code
@@ -314,7 +317,7 @@ default APIResponse patch(String url) {
    * response. The method will populate request cookies from the context and update context cookies from the response. The
    * method will automatically follow redirects.
    *
-   * <p> **Usage**
+   * <p> <strong>Usage</strong>
    *
    * <p> JSON objects can be passed directly to the request:
    * <pre>{@code
@@ -361,7 +364,7 @@ default APIResponse post(String url) {
    * response. The method will populate request cookies from the context and update context cookies from the response. The
    * method will automatically follow redirects.
    *
-   * <p> **Usage**
+   * <p> <strong>Usage</strong>
    *
    * <p> JSON objects can be passed directly to the request:
    * <pre>{@code

playwright/src/main/java/com/microsoft/playwright/APIResponse.java

@@ -20,8 +20,8 @@
 import java.util.*;
 
 /**
- * {@code APIResponse} class represents responses returned by {@link APIRequestContext#get APIRequestContext.get()} and
- * similar methods.
+ * {@code APIResponse} class represents responses returned by {@link com.microsoft.playwright.APIRequestContext#get
+ * APIRequestContext.get()} and similar methods.
  */
 public interface APIResponse {
   /**