summaryrefslogtreecommitdiffstats
path: root/examples/bluetooth/btchat
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2013-10-01 13:51:33 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-14 12:44:21 +0200
commitf674d4a5ade8b24dcb36c3c219c0fd5a842c1bfe (patch)
tree725cab8f631684432a473ebd00bb8727ccba450c /examples/bluetooth/btchat
parentf4474f93b9e0a7df48e94f3fec34a0de64b482bd (diff)
Doc: language and style review doc qtconnectivity
Reviewed doc Bluetooth and NFC Task-number: QTBUG-32173 Change-Id: I80f81c2123c3ee4fc269f471123f332dc39ee958 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples/bluetooth/btchat')
-rw-r--r--examples/bluetooth/btchat/doc/src/btchat.qdoc82
1 files changed, 41 insertions, 41 deletions
diff --git a/examples/bluetooth/btchat/doc/src/btchat.qdoc b/examples/bluetooth/btchat/doc/src/btchat.qdoc
index 6f1f040d..77f73fd1 100644
--- a/examples/bluetooth/btchat/doc/src/btchat.qdoc
+++ b/examples/bluetooth/btchat/doc/src/btchat.qdoc
@@ -34,36 +34,36 @@
\image btchat-example.png
- The Bluetooth Chat example implements a simple chat program between multiple parties. The
+ The Bluetooth Chat example implements a simple chat program between multiple parties. The
application always acts as both a server and a client eliminating the need to determine who
should connect to whom.
\section1 Chat Server
- The chat server is implemented by the ChatServer class. The ChatServer class is declared as:
+ The chat server is implemented by the ChatServer class. The ChatServer class is declared as:
\snippet btchat/chatserver.h declaration
The first thing the chat server needs to do is create an instance of QRfcommServer to listen
- for incoming Bluetooth connections. Our clientConnected() slot will be called whenever a new
+ for incoming Bluetooth connections. Our clientConnected() slot will be called whenever a new
connection is created.
\snippet btchat/chatserver.cpp Create the server
- The chat server is only useful if others know that it is there. To enable other devices to
- discover it a record describing the service needs to be published in the systems SDP (Service
- Discovery Protocol) database. The QBluetoothServiceInfo class encapsulates a service record.
+ The chat server is only useful if others know that it is there. To enable other devices to
+ discover it, a record describing the service needs to be published in the systems SDP (Service
+ Discovery Protocol) database. The QBluetoothServiceInfo class encapsulates a service record.
We will publish a service record that contains some textural descriptions of the services, a
- UUID that uniquely identifies the service, the discoverability attribute and connection
+ UUID that uniquely identifies the service, the discoverability attribute, and connection
parameters.
- The textural description of the service is stored in the ServiceName, ServiceDescription and
+ The textural description of the service is stored in the ServiceName, ServiceDescription, and
ServiceProvider attributes.
\snippet btchat/chatserver.cpp Service name, description and provider
- Bluetooth uses UUIDs as unique identifiers. Our chat service is uses a randomly generated
+ Bluetooth uses UUIDs as unique identifiers. The chat service uses a randomly generated
UUID.
\snippet btchat/chatserver.cpp Service UUID
@@ -74,78 +74,78 @@
\snippet btchat/chatserver.cpp Service Discoverability
The ProtocolDescriptorList attribute is used to publish the connection parameters that the
- remote device requires to connect to our service. Here we specify that the Rfcomm protocol is
- used and set the port number to port that our rfcommServer instance is listening to.
+ remote device requires to connect to our service. Here we specify that the Rfcomm protocol is
+ used and set the port number to the port that our rfcommServer instance is listening to.
\snippet btchat/chatserver.cpp Protocol descriptor list
- Finally we register the service record with the system.
+ Finally, we register the service record with the system.
\snippet btchat/chatserver.cpp Register service
- As mentioned earlier incoming connections are handled in the clientConnected() slot. In this
- slot we get a pointer a QBluetoothSocket representing the next pending connection connect up
- slots to the readyRead() and disconnected() signals and emit a signal to notify others that a
- new client has connected.
+
+ As mentioned earlier, incoming connections are handled in the clientConnected() slot where
+ pending connections are connected to the readyRead() and disconnected() signals. The signals
+ notify others that a new client has connected.
\snippet btchat/chatserver.cpp clientConnected
- The readSocket() slot is called whenever data is ready to be read from a client socket. The
- slot reads individual lines from the socket converts them from UTF-8 and emits the
+ The readSocket() slot is called whenever data is ready to be read from a client socket. The
+ slot reads individual lines from the socket, converts them from UTF-8, and emits the
messageReceived() signal.
\snippet btchat/chatserver.cpp readSocket
- The clientDisconnected() slot is called whenever a client disconnects from the service. The
- slot emits a signal to notify others that a client has disconnected and deletes the socket.
+ The clientDisconnected() slot is called whenever a client disconnects from the service. The
+ slot emits a signal to notify others that a client has disconnected, and deletes the socket.
\snippet btchat/chatserver.cpp clientDisconnected
- The sendMessage() slot is used to send a message to all connected clients. The message is
+ The sendMessage() slot is used to send a message to all connected clients. The message is
converted into UTF-8 and appended with a newline before being sent to all clients.
\snippet btchat/chatserver.cpp sendMessage
- When the chat server is stop the service record is removed from the system SDP database, all
- connected client sockets are deleted and the QRfcommServer instance is deleted.
+ When the chat server is stopped the service record is removed from the system SDP database, all
+ connected client sockets are deleted, and the QRfcommServer instance is deleted.
\snippet btchat/chatserver.cpp stopServer
\section1 Chat Client
- The chat client is implemented by the ChatClient class. The ChatClient class is declared as:
+ The chat client is implemented by the ChatClient class. The ChatClient class is declared as:
\snippet btchat/chatclient.h declaration
The client creates a new QBluetoothSocket and connects to the remote service described by the
- \e remoteService parameter. Slots are connected to the sockets readyRead(), connected() and
+ \e remoteService parameter. Slots are connected to the sockets readyRead(), connected() and
disconnected() signals.
\snippet btchat/chatclient.cpp startClient
- On sucessfull socket connection we emit a signal to notify other.
+ On successful socket connection we emit a signal to notify others.
\snippet btchat/chatclient.cpp connected
- Similarily to the chat server the readSocket() slot is called when data is available from the
- socket. Lines are read individually and converted from UTF-8. The messageReceived() signal
+ Similarly to the chat server, the readSocket() slot is called when data is available from the
+ socket. Lines are read individually and converted from UTF-8. The messageReceived() signal
is emitted.
\snippet btchat/chatclient.cpp readSocket
- The sendMessage() slot is used to send a message to the remote device. The message is
- converted to UTF-8 and a newline appended.
+ The sendMessage() slot is used to send a message to the remote device. The message is
+ converted to UTF-8 and a newline is appended.
\snippet btchat/chatclient.cpp sendMessage
- To disconnect from the remote chat service the QBluetoothSocket instance is deleted.
+ To disconnect from the remote chat service, the QBluetoothSocket instance is deleted.
\snippet btchat/chatclient.cpp stopClient
\section1 Chat Dialog
- The main window of this example is the chat dialog, implemented in the Chat class. This class
- displays a chat session between a single ChatServer and zero or more ChatClients. The Chat
+ The main window of this example is the chat dialog, implemented in the Chat class. This class
+ displays a chat session between a single ChatServer and zero or more ChatClients. The Chat
class is declared as:
\snippet btchat/chat.h declaration
@@ -155,27 +155,27 @@
\snippet btchat/chat.cpp Construct UI
We create an instance of the ChatServer and respond to its clientConnected(),
- clientDiconnected() and messageReceived() signals.
+ clientDiconnected(), and messageReceived() signals.
\snippet btchat/chat.cpp Create Chat Server
- In response to the clientConnected() and clientDisconnected() signals of the ChatServer we
- display the typical "foo has joined chat." and "foo has left." messages in the chat session.
+ In response to the clientConnected() and clientDisconnected() signals of the ChatServer, we
+ display the typical "X has joined chat." and "Y has left." messages in the chat session.
\snippet btchat/chat.cpp clientConnected clientDisconnected
Incoming messages from clients connected to the ChatServer are handled in the showMessage()
- slot. The message text tagged with the remote device name is displayed in the chat session.
+ slot. The message text tagged with the remote device name is displayed in the chat session.
\snippet btchat/chat.cpp showMessage
- In response to the connect button being clicked the application starts service discovery and
- presents a list of discovered chat services on remote devices. A ChatClient for the service
- selected by the user.
+ In response to the connect button being clicked, the application starts service discovery and
+ presents a list of discovered chat services on remote devices. A ChatClient for the service
+ is selected by the user.
\snippet btchat/chat.cpp Connect to remote service
- In reponse to connected() signals from ChatClient we display the a "Joined chat with foo."
+ In reponse to the connected() signals from ChatClient, we display the a "Joined chat with X."
message in the chat session.
\snippet btchat/chat.cpp connected