Browse Source

Change the parameter name for consistency

Ivan Mir 7 years ago
parent
commit
75b2915fee

+ 2 - 2
atom/browser/api/atom_api_app.cc

@@ -869,10 +869,10 @@ bool App::IsAccessibilitySupportEnabled() {
   return ax_state->IsAccessibleBrowser();
 }
 
-void App::SetAccessibilitySupportEnabled(bool value) {
+void App::SetAccessibilitySupportEnabled(bool enabled) {
   auto ax_state = content::BrowserAccessibilityState::GetInstance();
   
-  if (value) {
+  if (enabled) {
     ax_state->OnScreenReaderDetected();
   } else {
     ax_state->DisableAccessibility();

+ 1 - 1
atom/browser/api/atom_api_app.h

@@ -171,7 +171,7 @@ class App : public AtomBrowserClient::Delegate,
   void DisableHardwareAcceleration(mate::Arguments* args);
   void DisableDomainBlockingFor3DAPIs(mate::Arguments* args);
   bool IsAccessibilitySupportEnabled();
-  void SetAccessibilitySupportEnabled(bool value);
+  void SetAccessibilitySupportEnabled(bool enabled);
   Browser::LoginItemSettings GetLoginItemSettings(mate::Arguments* args);
 #if defined(USE_NSS_CERTS)
   void ImportCertificate(const base::DictionaryValue& options,

+ 2 - 2
docs/api/app.md

@@ -890,9 +890,9 @@ technologies, such as screen readers, has been detected. See
 https://www.chromium.org/developers/design-documents/accessibility for more
 details.
 
-### `app.setAccessibilitySupportEnabled(value)` _macOS_ _Windows_
+### `app.setAccessibilitySupportEnabled(enabled)` _macOS_ _Windows_
 
-* `value` Boolean - A value for switching the accessibility support
+* `enabled` Boolean - Enable or disable accessibility tree rendering
 
 Manually enables Chrome's accessibility support, allowing to expose accessibility switch to users in application settings. https://www.chromium.org/developers/design-documents/accessibility for more
 details.

+ 1 - 1
docs/tutorial/accessibility.md

@@ -38,7 +38,7 @@ Electron applications keep accessibility disabled by default for performance rea
 
 ### Inside Application
 
-By using [`app.setAccessibilitySupportEnabled(value)`](https://electron.atom.io/docs/api/app.md#appsetaccessibilitysupportenabledvalue-macos-windows), you can expose accessibility switch to users in the application preferences.
+By using [`app.setAccessibilitySupportEnabled(enabled)`](https://electron.atom.io/docs/api/app.md#appsetaccessibilitysupportenabledenabled-macos-windows), you can expose accessibility switch to users in the application preferences.
 
 ### Assistive Technology