docs: split ignoreDefaultArgs into 2 options for java (#5251)

microsoft · Feb 2, 2021 · cee394d · cee394d
1 parent 9e09bd3
commit cee394d
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 20 deletions.
diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md
@@ -129,11 +129,7 @@ Firefox or WebKit, use at your own risk.
 Additional arguments to pass to the browser instance. The list of Chromium flags can be found
 [here](http://peter.sh/experiments/chromium-command-line-switches/).
 
-### option: BrowserType.launch.ignoreDefaultArgs
-- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>>
-
-If `true`, Playwright does not pass its own configurations args and only uses the ones from [`option: args`]. If an
-array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.
+### option: BrowserType.launch.ignoreDefaultArgs = %%-browser-option-ignoredefaultargs-%%
 
 ### option: BrowserType.launch.proxy = %%-browser-option-proxy-%%
 
@@ -240,11 +236,7 @@ bundled Chromium, Firefox or WebKit, use at your own risk.
 Additional arguments to pass to the browser instance. The list of Chromium flags can be found
 [here](http://peter.sh/experiments/chromium-command-line-switches/).
 
-### option: BrowserType.launchPersistentContext.ignoreDefaultArgs
-- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>>
-
-If `true`, then do not use any of the default arguments. If an array is given, then filter out the given default
-arguments. Dangerous option; use with care. Defaults to `false`.
+### option: BrowserType.launchPersistentContext.ignoreDefaultArgs = %%-browser-option-ignoredefaultargs-%%
 
 ### option: BrowserType.launchPersistentContext.proxy = %%-browser-option-proxy-%%
 
@@ -347,11 +339,7 @@ bundled Chromium, Firefox or WebKit, use at your own risk.
 Additional arguments to pass to the browser instance. The list of Chromium flags can be found
 [here](http://peter.sh/experiments/chromium-command-line-switches/).
 
-### option: BrowserType.launchServer.ignoreDefaultArgs
-- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>>
-
-If `true`, then do not use any of the default arguments. If an array is given, then filter out the given default
-arguments. Dangerous option; use with care. Defaults to `false`.
+### option: BrowserType.launchServer.ignoreDefaultArgs = %%-browser-option-ignoredefaultargs-%%
 
 ### option: BrowserType.launchServer.proxy = %%-browser-option-proxy-%%
 

diff --git a/docs/src/api/java.md b/docs/src/api/java.md
@@ -1,4 +1,9 @@
 ## method: Playwright.close
 * langs: java
 
-Terminates this instance of Playwright, will also close all created browsers if they are still running.
+Terminates this instance of Playwright, will also close all created browsers if they are still running.
+
+### option: BrowserType.launch.ignoreDefaultArgs = %%-csharp-java-browser-option-ignoredefaultargs-%%
+### option: BrowserType.launchPersistentContext.ignoreDefaultArgs = %%-csharp-java-browser-option-ignoredefaultargs-%%
+### option: BrowserType.launch.ignoreAllDefaultArgs = %%-csharp-java-browser-option-ignorealldefaultargs-%%
+### option: BrowserType.launchPersistentContext.ignoreAllDefaultArgs = %%-csharp-java-browser-option-ignorealldefaultargs-%%
diff --git a/docs/src/api/params.md b/docs/src/api/params.md
@@ -98,6 +98,27 @@ Defaults to `'visible'`. Can be either:
 * `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or `visibility:hidden`.
   This is opposite to the `'visible'` option.
 
+## browser-option-ignoredefaultargs
+* langs: js, python
+- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>>
+
+If `true`, Playwright does not pass its own configurations args and only uses the ones from [`option: args`]. If an
+array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.
+
+## csharp-java-browser-option-ignoredefaultargs
+* langs: csharp, java
+- `ignoreDefaultArgs` <[Array]<[string]>>
+
+If `true`, Playwright does not pass its own configurations args and only uses the ones from [`option: args`].
+Dangerous option; use with care.
+
+## csharp-java-browser-option-ignorealldefaultargs
+* langs: csharp, java
+- `ignoreAllDefaultArgs` <[boolean]>
+
+If `true`, Playwright does not pass its own configurations args and only uses the ones from [`option: args`].
+Dangerous option; use with care. Defaults to `false`.
+
 ## browser-option-proxy
 - `proxy` <[Object]>
   - `server` <[string]> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example

diff --git a/types/types.d.ts b/types/types.d.ts
@@ -6378,8 +6378,8 @@ export interface BrowserType<Browser> {
     };
 
     /**
-     * If `true`, then do not use any of the default arguments. If an array is given, then filter out the given default
-     * arguments. Dangerous option; use with care. Defaults to `false`.
+     * If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is
+     * given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.
      */
     ignoreDefaultArgs?: boolean|Array<string>;
 
@@ -6644,8 +6644,8 @@ export interface BrowserType<Browser> {
     headless?: boolean;
 
     /**
-     * If `true`, then do not use any of the default arguments. If an array is given, then filter out the given default
-     * arguments. Dangerous option; use with care. Defaults to `false`.
+     * If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is
+     * given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.
      */
     ignoreDefaultArgs?: boolean|Array<string>;