feat: generate @SInCE tags for methods (#1145)

Author: yury-s

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

@@ -176,12 +176,16 @@ public NewContextOptions setUserAgent(String userAgent) {
   }
   /**
    * Creates new instances of {@code APIRequestContext}.
+   *
+   * @since v1.16
    */
   default APIRequestContext newContext() {
     return newContext(null);
   }
   /**
    * Creates new instances of {@code APIRequestContext}.
+   *
+   * @since v1.16
    */
   APIRequestContext newContext(NewContextOptions options);
 }

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

@@ -63,6 +63,7 @@ public StorageStateOptions setPath(Path path) {
    * The method will automatically follow redirects.
    *
    * @param url Target URL.
+   * @since v1.16
    */
   default APIResponse delete(String url) {
     return delete(url, null);
@@ -74,12 +75,15 @@ default APIResponse delete(String url) {
    *
    * @param url Target URL.
    * @param params Optional request parameters.
+   * @since v1.16
    */
   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 stored
    * responses, and makes {@link APIResponse#body APIResponse.body()} throw "Response disposed" error.
+   *
+   * @since v1.16
    */
   void dispose();
   /**
@@ -113,6 +117,7 @@ default APIResponse delete(String url) {
    * }</pre>
    *
    * @param urlOrRequest Target URL or Request to get all parameters from.
+   * @since v1.16
    */
   default APIResponse fetch(String urlOrRequest) {
     return fetch(urlOrRequest, null);
@@ -149,6 +154,7 @@ default APIResponse fetch(String urlOrRequest) {
    *
    * @param urlOrRequest Target URL or Request to get all parameters from.
    * @param params Optional request parameters.
+   * @since v1.16
    */
   APIResponse fetch(String urlOrRequest, RequestOptions params);
   /**
@@ -182,6 +188,7 @@ default APIResponse fetch(String urlOrRequest) {
    * }</pre>
    *
    * @param urlOrRequest Target URL or Request to get all parameters from.
+   * @since v1.16
    */
   default APIResponse fetch(Request urlOrRequest) {
     return fetch(urlOrRequest, null);
@@ -218,6 +225,7 @@ default APIResponse fetch(Request urlOrRequest) {
    *
    * @param urlOrRequest Target URL or Request to get all parameters from.
    * @param params Optional request parameters.
+   * @since v1.16
    */
   APIResponse fetch(Request urlOrRequest, RequestOptions params);
   /**
@@ -235,6 +243,7 @@ default APIResponse fetch(Request urlOrRequest) {
    * }</pre>
    *
    * @param url Target URL.
+   * @since v1.16
    */
   default APIResponse get(String url) {
     return get(url, null);
@@ -255,6 +264,7 @@ default APIResponse get(String url) {
    *
    * @param url Target URL.
    * @param params Optional request parameters.
+   * @since v1.16
    */
   APIResponse get(String url, RequestOptions params);
   /**
@@ -263,6 +273,7 @@ default APIResponse get(String url) {
    * method will automatically follow redirects.
    *
    * @param url Target URL.
+   * @since v1.16
    */
   default APIResponse head(String url) {
     return head(url, null);
@@ -274,6 +285,7 @@ default APIResponse head(String url) {
    *
    * @param url Target URL.
    * @param params Optional request parameters.
+   * @since v1.16
    */
   APIResponse head(String url, RequestOptions params);
   /**
@@ -282,6 +294,7 @@ default APIResponse head(String url) {
    * The method will automatically follow redirects.
    *
    * @param url Target URL.
+   * @since v1.16
    */
   default APIResponse patch(String url) {
     return patch(url, null);
@@ -293,6 +306,7 @@ default APIResponse patch(String url) {
    *
    * @param url Target URL.
    * @param params Optional request parameters.
+   * @since v1.16
    */
   APIResponse patch(String url, RequestOptions params);
   /**
@@ -337,6 +351,7 @@ default APIResponse patch(String url) {
    * }</pre>
    *
    * @param url Target URL.
+   * @since v1.16
    */
   default APIResponse post(String url) {
     return post(url, null);
@@ -384,6 +399,7 @@ default APIResponse post(String url) {
    *
    * @param url Target URL.
    * @param params Optional request parameters.
+   * @since v1.16
    */
   APIResponse post(String url, RequestOptions params);
   /**
@@ -392,6 +408,7 @@ default APIResponse post(String url) {
    * method will automatically follow redirects.
    *
    * @param url Target URL.
+   * @since v1.16
    */
   default APIResponse put(String url) {
     return put(url, null);
@@ -403,18 +420,23 @@ default APIResponse put(String url) {
    *
    * @param url Target URL.
    * @param params Optional request parameters.
+   * @since v1.16
    */
   APIResponse put(String url, RequestOptions params);
   /**
    * Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to
    * the constructor.
+   *
+   * @since v1.16
    */
   default String storageState() {
     return storageState(null);
   }
   /**
    * Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to
    * the constructor.
+   *
+   * @since v1.16
    */
   String storageState(StorageStateOptions options);
 }

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

@@ -26,39 +26,57 @@
 public interface APIResponse {
   /**
    * Returns the buffer with response body.
+   *
+   * @since v1.16
    */
   byte[] body();
   /**
    * Disposes the body of this response. If not called then the body will stay in memory until the context closes.
+   *
+   * @since v1.16
    */
   void dispose();
   /**
    * An object with all the response HTTP headers associated with this response.
+   *
+   * @since v1.16
    */
   Map<String, String> headers();
   /**
    * An array with all the request HTTP headers associated with this response. Header names are not lower-cased. Headers with
    * multiple entries, such as {@code Set-Cookie}, appear in the array multiple times.
+   *
+   * @since v1.16
    */
   List<HttpHeader> headersArray();
   /**
    * Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
+   *
+   * @since v1.16
    */
   boolean ok();
   /**
    * Contains the status code of the response (e.g., 200 for a success).
+   *
+   * @since v1.16
    */
   int status();
   /**
    * Contains the status text of the response (e.g. usually an "OK" for a success).
+   *
+   * @since v1.16
    */
   String statusText();
   /**
    * Returns the text representation of response body.
+   *
+   * @since v1.16
    */
   String text();
   /**
    * Contains the URL of the response.
+   *
+   * @since v1.16
    */
   String url();
 }

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

@@ -1084,6 +1084,8 @@ public StartTracingOptions setScreenshots(boolean screenshots) {
   }
   /**
    * Get the browser type (chromium, firefox or webkit) that the browser belongs to.
+   *
+   * @since v1.23
    */
   BrowserType browserType();
   /**
@@ -1098,6 +1100,8 @@ public StartTracingOptions setScreenshots(boolean screenshots) {
    * Browser.newContext()} **before** calling {@link Browser#close Browser.close()}.
    *
    * <p> The {@code Browser} object itself is considered to be disposed and cannot be used anymore.
+   *
+   * @since v1.8
    */
   void close();
   /**
@@ -1110,10 +1114,14 @@ public StartTracingOptions setScreenshots(boolean screenshots) {
    * BrowserContext context = browser.newContext();
    * System.out.println(browser.contexts().size()); // prints "1"
    * }</pre>
+   *
+   * @since v1.8
    */
   List<BrowserContext> contexts();
   /**
    * Indicates that the browser is connected.
+   *
+   * @since v1.8
    */
   boolean isConnected();
   /**
@@ -1137,6 +1145,8 @@ public StartTracingOptions setScreenshots(boolean screenshots) {
    * context.close();
    * browser.close();
    * }</pre>
+   *
+   * @since v1.8
    */
   default BrowserContext newContext() {
     return newContext(null);
@@ -1162,6 +1172,8 @@ default BrowserContext newContext() {
    * context.close();
    * browser.close();
    * }</pre>
+   *
+   * @since v1.8
    */
   BrowserContext newContext(NewContextOptions options);
   /**
@@ -1170,6 +1182,8 @@ default BrowserContext newContext() {
    * <p> This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and
    * testing frameworks should explicitly create {@link Browser#newContext Browser.newContext()} followed by the {@link
    * BrowserContext#newPage BrowserContext.newPage()} to control their exact life times.
+   *
+   * @since v1.8
    */
   default Page newPage() {
     return newPage(null);
@@ -1180,6 +1194,8 @@ default Page newPage() {
    * <p> This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and
    * testing frameworks should explicitly create {@link Browser#newContext Browser.newContext()} followed by the {@link
    * BrowserContext#newPage BrowserContext.newPage()} to control their exact life times.
+   *
+   * @since v1.8
    */
   Page newPage(NewPageOptions options);
   /**
@@ -1200,6 +1216,7 @@ default Page newPage() {
    * }</pre>
    *
    * @param page Optional, if specified, tracing includes screenshots of the given page.
+   * @since v1.11
    */
   default void startTracing(Page page) {
     startTracing(page, null);
@@ -1220,6 +1237,8 @@ default void startTracing(Page page) {
    * page.goto('https://www.google.com');
    * browser.stopTracing();
    * }</pre>
+   *
+   * @since v1.11
    */
   default void startTracing() {
     startTracing(null);
@@ -1242,6 +1261,7 @@ default void startTracing() {
    * }</pre>
    *
    * @param page Optional, if specified, tracing includes screenshots of the given page.
+   * @since v1.11
    */
   void startTracing(Page page, StartTracingOptions options);
   /**
@@ -1251,10 +1271,14 @@ default void startTracing() {
    * href="https://playwright.dev/java/docs/api/class-tracing">here</a>.
    *
    * <p> Returns the buffer with trace data.
+   *
+   * @since v1.11
    */
   byte[] stopTracing();
   /**
    * Returns the browser version.
+   *
+   * @since v1.8
    */
   String version();
 }