Skip to content

Commit

Permalink
document default behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
amrbashir committed Oct 23, 2024
1 parent 5a6d558 commit b48b752
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion crates/tauri-cli/config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@
"type": "boolean"
},
"devtools": {
"description": "Enable web inspector which is usually called browser devtools.\n\n It is enabled in **debug** builds, but requires `devtools` feature flag to actually enable it in **release** builds.\n\n ## Platform-specific\n\n - macOS: This will call private functions on **macOS**.\n - Android: Open `chrome://inspect/#devices` in Chrome to get the devtools window. Wry's `WebView` devtools API isn't supported on Android.\n - iOS: Open Safari > Develop > [Your Device Name] > [Your WebView] to get the devtools window.",
"description": "Enable web inspector which is usually called browser devtools. Enabled by default.\n\n This API works in **debug** builds, but requires `devtools` feature flag to enable it in **release** builds.\n\n ## Platform-specific\n\n - macOS: This will call private functions on **macOS**.\n - Android: Open `chrome://inspect/#devices` in Chrome to get the devtools window. Wry's `WebView` devtools API isn't supported on Android.\n - iOS: Open Safari > Develop > [Your Device Name] > [Your WebView] to get the devtools window.",
"type": [
"boolean",
"null"
Expand Down
4 changes: 2 additions & 2 deletions crates/tauri-runtime/src/webview.rs
Original file line number Diff line number Diff line change
Expand Up @@ -382,9 +382,9 @@ impl WebviewAttributes {
self
}

/// Whether web inspector, which is usually called browser devtools, is enabled or not.
/// Whether web inspector, which is usually called browser devtools, is enabled or not. Enabled by default.
///
/// It is enabled in **debug** builds, but requires `devtools` feature flag to actually enable it in **release** builds.
/// This API works in **debug** builds, but requires `devtools` feature flag to enable it in **release** builds.
///
/// ## Platform-specific
///
Expand Down
2 changes: 1 addition & 1 deletion crates/tauri-schema-generator/schemas/config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@
"type": "boolean"
},
"devtools": {
"description": "Enable web inspector which is usually called browser devtools.\n\n It is enabled in **debug** builds, but requires `devtools` feature flag to actually enable it in **release** builds.\n\n ## Platform-specific\n\n - macOS: This will call private functions on **macOS**.\n - Android: Open `chrome://inspect/#devices` in Chrome to get the devtools window. Wry's `WebView` devtools API isn't supported on Android.\n - iOS: Open Safari > Develop > [Your Device Name] > [Your WebView] to get the devtools window.",
"description": "Enable web inspector which is usually called browser devtools. Enabled by default.\n\n This API works in **debug** builds, but requires `devtools` feature flag to enable it in **release** builds.\n\n ## Platform-specific\n\n - macOS: This will call private functions on **macOS**.\n - Android: Open `chrome://inspect/#devices` in Chrome to get the devtools window. Wry's `WebView` devtools API isn't supported on Android.\n - iOS: Open Safari > Develop > [Your Device Name] > [Your WebView] to get the devtools window.",
"type": [
"boolean",
"null"
Expand Down
4 changes: 2 additions & 2 deletions crates/tauri-utils/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1486,9 +1486,9 @@ pub struct WindowConfig {
/// - **MacOS / Linux / iOS / Android** - Unsupported.
#[serde(default)]
pub browser_extensions_enabled: bool,
/// Enable web inspector which is usually called browser devtools.
/// Enable web inspector which is usually called browser devtools. Enabled by default.
///
/// It is enabled in **debug** builds, but requires `devtools` feature flag to actually enable it in **release** builds.
/// This API works in **debug** builds, but requires `devtools` feature flag to enable it in **release** builds.
///
/// ## Platform-specific
///
Expand Down
4 changes: 2 additions & 2 deletions crates/tauri/src/webview/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -788,9 +788,9 @@ fn main() {
self
}

/// Whether web inspector, which is usually called browser devtools, is enabled or not.
/// Whether web inspector, which is usually called browser devtools, is enabled or not. Enabled by default.
///
/// It is enabled in **debug** builds, but requires `devtools` feature flag to actually enable it in **release** builds.
/// This API works in **debug** builds, but requires `devtools` feature flag to enable it in **release** builds.
///
/// ## Platform-specific
///
Expand Down
4 changes: 2 additions & 2 deletions crates/tauri/src/webview/webview_window.rs
Original file line number Diff line number Diff line change
Expand Up @@ -897,9 +897,9 @@ impl<'a, R: Runtime, M: Manager<R>> WebviewWindowBuilder<'a, R, M> {
self
}

/// Whether web inspector, which is usually called browser devtools, is enabled or not.
/// Whether web inspector, which is usually called browser devtools, is enabled or not. Enabled by default.
///
/// It is enabled in **debug** builds, but requires `devtools` feature flag to actually enable it in **release** builds.
/// This API works in **debug** builds, but requires `devtools` feature flag to enable it in **release** builds.
///
/// ## Platform-specific
///
Expand Down
4 changes: 2 additions & 2 deletions packages/api/src/webview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -729,9 +729,9 @@ interface WebviewOptions {
*/
zoomHotkeysEnabled?: boolean
/**
* Whether web inspector, which is usually called browser devtools, is enabled or not.
* Whether web inspector, which is usually called browser devtools, is enabled or not. Enabled by default.
*
* It is enabled in **debug** builds, but requires `devtools` feature flag to actually enable it in **release** builds.
* This API works in **debug** builds, but requires `devtools` feature flag to enable it in **release** builds.
*
* #### Platform-specific
*
Expand Down

0 comments on commit b48b752

Please sign in to comment.