summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@theqtcompany.com>2016-08-12 11:29:28 +0200
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2016-08-16 15:04:15 +0000
commit95513185fd90cb9372a8cb8b541de7a3f41b12d4 (patch)
tree3153106b3d50b0dccd7d1b678b3d9c3b6d1e016a
parentf5fe6ce47841be34d4b851725d80133ff6d14fee (diff)
Doc: Change instances of 'OS X' to 'macOS'
As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change all occurrences where the platform is discussed to use the macro \macos (defined in the documentation configuration in qtbase). Change-Id: I97f7a0d6d2ca351395bed518f01d4365b986500a Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r--src/bluetooth/doc/src/bluetooth-index.qdoc4
-rw-r--r--src/bluetooth/qbluetoothdeviceinfo.cpp8
-rw-r--r--src/bluetooth/qbluetoothlocaldevice.cpp18
-rw-r--r--src/bluetooth/qbluetoothserver.cpp2
-rw-r--r--src/bluetooth/qbluetoothsocket.cpp6
-rw-r--r--src/bluetooth/qlowenergycharacteristic.cpp4
-rw-r--r--src/bluetooth/qlowenergydescriptor.cpp2
7 files changed, 22 insertions, 22 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc
index 5fd96539..e8b74cfb 100644
--- a/src/bluetooth/doc/src/bluetooth-index.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-index.qdoc
@@ -35,7 +35,7 @@ The Bluetooth API provides connectivity between Bluetooth enabled devices.
Currently, the API is supported on the following platforms: \l{Qt for Android}{Android},
\l{Qt for iOS}{iOS}, \l{Qt for Linux/X11}{Linux}
-(\l{http://www.bluez.org}{BlueZ 4.x/5.x}) and \l{Qt for OS X}{OS X}.
+(\l{http://www.bluez.org}{BlueZ 4.x/5.x}) and \l{Qt for macOS}{\macos}.
\section1 Overview
@@ -111,7 +111,7 @@ The \l QtBluetooth module exports the following
\li Enables logging of the iOS implementation
\row
\li qt.bluetooth.osx
- \li Enables logging of the OS X implementation
+ \li Enables logging of the \macos implementation
\endtable
\section2 Examples
diff --git a/src/bluetooth/qbluetoothdeviceinfo.cpp b/src/bluetooth/qbluetoothdeviceinfo.cpp
index f6002a30..49ef11a1 100644
--- a/src/bluetooth/qbluetoothdeviceinfo.cpp
+++ b/src/bluetooth/qbluetoothdeviceinfo.cpp
@@ -310,7 +310,7 @@ QBluetoothDeviceInfo::QBluetoothDeviceInfo(const QBluetoothAddress &address, con
Constructs a QBluetoothDeviceInfo object with unique \a uuid, device name
\a name and the encoded class of device \a classOfDevice.
- This constructor is required for Low Energy devices on OS X and iOS. CoreBluetooth
+ This constructor is required for Low Energy devices on \macos and iOS. CoreBluetooth
API hides addresses and provides unique UUIDs to identify a device. This UUID is
not the same thing as a service UUID and is required to work later with CoreBluetooth API
and discovered devices.
@@ -454,7 +454,7 @@ bool QBluetoothDeviceInfo::operator!=(const QBluetoothDeviceInfo &other) const
/*!
Returns the address of the device.
- \note On iOS and OS X this address is invalid. Instead \l deviceUuid() should be used.
+ \note On iOS and \macos this address is invalid. Instead \l deviceUuid() should be used.
Those two platforms do not expose Bluetooth addresses for found Bluetooth devices
and utilize unique device identifiers.
@@ -607,7 +607,7 @@ void QBluetoothDeviceInfo::setCached(bool cached)
/*!
Sets the unique identifier \a uuid for Bluetooth devices, that do not have addresses.
- This happens on OS X and iOS, where the CoreBluetooth API hides addresses, but provides
+ This happens on \macos and iOS, where the CoreBluetooth API hides addresses, but provides
UUIDs to identify devices/peripherals.
This uuid is invalid on any other platform.
@@ -625,7 +625,7 @@ void QBluetoothDeviceInfo::setDeviceUuid(const QBluetoothUuid &uuid)
/*!
Returns a unique identifier for a Bluetooth device without an address.
- In general, this uuid is invalid on every platform but OS X and iOS.
+ In general, this uuid is invalid on every platform but \macos and iOS.
It is used as a workaround for those two platforms as they do not
provide Bluetooth addresses for found Bluetooth Low Energy devices.
Every other platform uses \l address() instead.
diff --git a/src/bluetooth/qbluetoothlocaldevice.cpp b/src/bluetooth/qbluetoothlocaldevice.cpp
index 390dc206..a6c9ef44 100644
--- a/src/bluetooth/qbluetoothlocaldevice.cpp
+++ b/src/bluetooth/qbluetoothlocaldevice.cpp
@@ -93,7 +93,7 @@ QT_BEGIN_NAMESPACE
only made discoverable for a limited period of time. This can speed up discovery between gaming devices,
as service discovery can be skipped on devices not in LimitedInquiry mode. In this mode, the device will
be connectable and powered on, if required. This mode is is not supported on Android.
- On OS X, it is not possible to set the \l hostMode() to HostConnectable or HostPoweredOff.
+ On \macos, it is not possible to set the \l hostMode() to HostConnectable or HostPoweredOff.
*/
@@ -147,7 +147,7 @@ bool QBluetoothLocalDevice::isValid() const
\note Due to varying security policies on the supported platforms, this method may have
differing behaviors on the various platforms. For example the system may ask the user for
confirmation before turning Bluetooth on or off and not all host modes may be supported.
- On OS X, it is not possbile to programmatically change the \l hostMode().
+ On \macos, it is not possbile to programmatically change the \l hostMode().
A user can only switch Bluetooth on/off in the System Preferences.
Please refer to the platform specific Bluetooth documentation for details.
*/
@@ -155,7 +155,7 @@ bool QBluetoothLocalDevice::isValid() const
/*!
\fn QBluetoothLocalDevice::HostMode QBluetoothLocalDevice::hostMode() const
- Returns the current host mode of this local Bluetooth device. On OS X, it is either
+ Returns the current host mode of this local Bluetooth device. On \macos, it is either
HostPoweredOff or HostConnectable.
*/
@@ -178,7 +178,7 @@ bool QBluetoothLocalDevice::isValid() const
/*!
\fn QList<QBluetoothLocalDevice> QBluetoothLocalDevice::allDevices()
- Returns a list of all available local Bluetooth devices. On OS X, there is
+ Returns a list of all available local Bluetooth devices. On \macos, there is
only the "default" local device.
*/
@@ -190,7 +190,7 @@ bool QBluetoothLocalDevice::isValid() const
\note Due to varying security policies on the supported platforms, this method may have
differing behaviors on the various platforms. For example
the system may ask the user for confirmation before turning Bluetooth on or off.
- On OS X it is not possible to power on/off Bluetooth.
+ On \macos it is not possible to power on/off Bluetooth.
Please refer to the platform specific Bluetooth documentation for details.
*/
@@ -231,7 +231,7 @@ bool QBluetoothLocalDevice::isValid() const
Returns the list of connected devices. This list is different from the list of currently
paired devices.
- On Android and OS X, it is not possible to retrieve a list of connected devices. It is only possible to
+ On Android and \macos, it is not possible to retrieve a list of connected devices. It is only possible to
listen to (dis)connect changes. For convenience, this class monitors all connect
and disconnect events since its instanciation and returns the current list when calling this function.
Therefore it is possible that this function returns an empty list shortly after creating an
@@ -254,7 +254,7 @@ bool QBluetoothLocalDevice::isValid() const
must be called to indicate if the user accepts or rejects the displayed pin.
This signal is only emitted for pairing requests issues by calling \l requestPairing().
- On OS X, this method never gets called - there is a callback with a PIN (IOBluetooth),
+ On \macos, this method never gets called - there is a callback with a PIN (IOBluetooth),
but it expects immediate reply yes/no - and there is no time to show any dialog or compare PINs.
\sa pairingConfirmation()
@@ -282,9 +282,9 @@ bool QBluetoothLocalDevice::isValid() const
\fn QBluetoothLocalDevice::requestPairing(const QBluetoothAddress &address, Pairing pairing)
Set the \a pairing status with \a address. The results are returned by the signal, pairingFinished().
- On Android and OS X, AuthorizedPaired is not possible and will have the same behavior as Paired.
+ On Android and \macos, AuthorizedPaired is not possible and will have the same behavior as Paired.
- On OS X, it is not possible to unpair a device. If Unpaired is requested, \l pairingFinished()
+ On \macos, it is not possible to unpair a device. If Unpaired is requested, \l pairingFinished()
is immediately emitted although the device remains paired. It is possible to request the pairing
for a previously unpaired device. In addition \l AuthorizedPaired has the same behavior as \l Paired.
diff --git a/src/bluetooth/qbluetoothserver.cpp b/src/bluetooth/qbluetoothserver.cpp
index be198950..bd518852 100644
--- a/src/bluetooth/qbluetoothserver.cpp
+++ b/src/bluetooth/qbluetoothserver.cpp
@@ -280,7 +280,7 @@ int QBluetoothServer::maxPendingConnections() const
\l QBluetooth::NoSecurity the server object will not employ any authentication or encryption.
Any other security flag combination will trigger a secure Bluetooth connection.
- On OS X, security flags are not supported and will be ignored.
+ On \macos, security flags are not supported and will be ignored.
*/
/*!
diff --git a/src/bluetooth/qbluetoothsocket.cpp b/src/bluetooth/qbluetoothsocket.cpp
index 7adb56b4..2b2264e8 100644
--- a/src/bluetooth/qbluetoothsocket.cpp
+++ b/src/bluetooth/qbluetoothsocket.cpp
@@ -201,7 +201,7 @@ Q_DECLARE_LOGGING_CATEGORY(QT_BT)
Although some platforms may differ the socket must generally be connected to guarantee
the return of a valid port number.
- On Android and OS X, this feature is not supported and returns 0.
+ On Android and \macos, this feature is not supported and returns 0.
*/
/*!
@@ -498,7 +498,7 @@ QString QBluetoothSocket::errorString() const
On Bluez this property is set to QBluetooth::Authorization by default.
- On OS X, this value is ignored as the platform does not permit access
+ On \macos, this value is ignored as the platform does not permit access
to the security parameter of the socket. By default the platform prefers
secure/encrypted connections though and therefore this function always
returns \l QBluetooth::Secure.
@@ -532,7 +532,7 @@ void QBluetoothSocket::setPreferredSecurityFlags(QBluetooth::SecurityFlags flags
during or after the connection has been established. If such a change happens
it is not reflected in the value of this flag.
- On OS X, this flag is always set to \l QBluetooth::Secure.
+ On \macos, this flag is always set to \l QBluetooth::Secure.
\sa setPreferredSecurityFlags()
diff --git a/src/bluetooth/qlowenergycharacteristic.cpp b/src/bluetooth/qlowenergycharacteristic.cpp
index 885b1337..8b0f3172 100644
--- a/src/bluetooth/qlowenergycharacteristic.cpp
+++ b/src/bluetooth/qlowenergycharacteristic.cpp
@@ -212,7 +212,7 @@ QByteArray QLowEnergyCharacteristic::value() const
or \c 0 if the handle cannot be accessed on the platform or
if the characteristic is invalid.
- \note On OS X and iOS handles can differ from 0, but these
+ \note On \macos and iOS handles can differ from 0, but these
values have no special meaning outside of internal/private API.
*/
QLowEnergyHandle QLowEnergyCharacteristic::handle() const
@@ -314,7 +314,7 @@ bool QLowEnergyCharacteristic::isValid() const
\c 0 if the handle cannot be accessed on the platform or if the
characteristic is invalid.
- \note On OS X and iOS handles can differ from 0, but these
+ \note On \macos and iOS handles can differ from 0, but these
values have no special meaning outside of internal/private API.
\sa isValid()
diff --git a/src/bluetooth/qlowenergydescriptor.cpp b/src/bluetooth/qlowenergydescriptor.cpp
index cf1f46fa..4aa806d8 100644
--- a/src/bluetooth/qlowenergydescriptor.cpp
+++ b/src/bluetooth/qlowenergydescriptor.cpp
@@ -220,7 +220,7 @@ QBluetoothUuid QLowEnergyDescriptor::uuid() const
Returns the handle of the descriptor or \c 0 if the handle
cannot be accessed on the platform or the descriptor is invalid.
- \note On OS X and iOS handles can differ from 0, but these
+ \note On \macos and iOS handles can differ from 0, but these
values have no special meaning outside of internal/private API.
*/
QLowEnergyHandle QLowEnergyDescriptor::handle() const