diff options
| author | Laszlo Papp <lpapp@kde.org> | 2014-01-16 11:47:14 +0000 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-02-02 16:24:54 +0100 |
| commit | 1335bcd134c012cd00dd6c542bc7b734269b6479 (patch) | |
| tree | dfdacb91bb5eb0782a4e0b5240864e9c8f9c1029 | |
| parent | 1824ad0a6e97e293098c94a038abd7b2343bf572 (diff) | |
| download | qtserialport-1335bcd134c012cd00dd6c542bc7b734269b6479.tar.gz | |
Rewrite the short description of the handle() method
* handle() is duplicated since the description explains that method.
* It is pointless to put the "object" into the sentence.
* It is consistent to start the sentence with the "if".
Here goes a typical example that is worth following with consistency:
"If successful, returns true; otherwise returns false."
Change-Id: I1c7648237c75381b8452b8c47a59445fff58ad34
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
| -rw-r--r-- | src/serialport/qserialport.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp index 56aabda..b878063 100644 --- a/src/serialport/qserialport.cpp +++ b/src/serialport/qserialport.cpp @@ -1282,8 +1282,8 @@ bool QSerialPort::waitForReadyRead(int msecs) \fn QSerialPort::Handle QSerialPort::handle() \since 5.2 - Returns the native serial port descriptor of the object. If the serial port - is not open or the platform is not supported, handle() returns -1. + If the platform is supported and the serial port is open, returns the native + serial port handle; otherwise returns -1. \warning This function is for expert use only; use it at your own risk. Furthermore, this function carries no compatibility promise between minor |