diff options
| author | Denis Shienkov <denis.shienkov@gmail.com> | 2016-12-25 13:17:39 +0300 |
|---|---|---|
| committer | Denis Shienkov <denis.shienkov@gmail.com> | 2017-01-04 09:30:44 +0000 |
| commit | f640521532087dc76d36b25a6c49b2f64afcd4de (patch) | |
| tree | 69beb1ff0ab3b8c9c8f6259c406aaee25dac2207 /src/serialport/qserialportinfo.cpp | |
| parent | 2ddb4ebeb61eb2df591191e14e48dc28d7334f2e (diff) | |
| download | qtserialport-f640521532087dc76d36b25a6c49b2f64afcd4de.tar.gz | |
Improve documentation a bit
... where has been added the '\c' tag where it is required.
Change-Id: Ie346fc147deb535501eb365693a2ff5fe22a98f9
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Diffstat (limited to 'src/serialport/qserialportinfo.cpp')
| -rw-r--r-- | src/serialport/qserialportinfo.cpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/serialport/qserialportinfo.cpp b/src/serialport/qserialportinfo.cpp index d978665..2547e01 100644 --- a/src/serialport/qserialportinfo.cpp +++ b/src/serialport/qserialportinfo.cpp @@ -228,8 +228,8 @@ quint16 QSerialPortInfo::productIdentifier() const } /*! - Returns true if there is a valid 16-bit vendor number present; otherwise - returns false. + Returns \c true if there is a valid \c 16-bit vendor number present; otherwise + returns \c false. \sa vendorIdentifier(), productIdentifier(), hasProductIdentifier() */ @@ -240,8 +240,8 @@ bool QSerialPortInfo::hasVendorIdentifier() const } /*! - Returns true if there is a valid 16-bit product number present; otherwise - returns false. + Returns \c true if there is a valid \c 16-bit product number present; otherwise + returns \c false. \sa productIdentifier(), vendorIdentifier(), hasVendorIdentifier() */ @@ -264,8 +264,8 @@ bool QSerialPortInfo::hasProductIdentifier() const /*! \fn bool QSerialPortInfo::isBusy() const - Returns true if serial port is busy; - otherwise returns false. + Returns \c true if serial port is busy; + otherwise returns \c false. \sa isNull() */ @@ -276,8 +276,8 @@ bool QSerialPortInfo::hasProductIdentifier() const \fn bool QSerialPortInfo::isValid() const \obsolete - Returns true if serial port is present on system; - otherwise returns false. + Returns \c true if serial port is present on system; + otherwise returns \c false. \sa isNull(), isBusy() */ |