Refactor the reference in the documentation for property setters/getters

The documentation contains broken links due to this, and it is also inconsistent
with the rest. Properties should be referred to as properties, not individual
methods like setter, getter, notified signal, etc.

The change is tested with "make docs" and the broken links are history.

Change-Id: Id94cba1f88503754318c865793229e3d3947bec6
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>

1 files changed, 5 insertions, 6 deletions

diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp
index 1fca425..b41e7a5 100644
--- a/src/serialport/qserialport.cpp
+++ b/src/serialport/qserialport.cpp
@@ -116,10 +116,10 @@ int QSerialPortPrivateData::timeoutValue(int msecs, int elapsed)
     port to the desired setting using the setBaudRate(), setDataBits(),
     setParity(), setStopBits(), and setFlowControl() methods.
 
-    The status of the control pinout signals is determined with the
-    isDataTerminalReady(), isRequestToSend, and pinoutSignals() methods. To
-    change the control line status, use the setDataTerminalReady(), and
-    setRequestToSend() methods.
+    There are a couple of properties to work with the pinout signals namely:
+    QSerialPort::dataTerminalReady, QSerialPort::requestToSend. It is also
+    possible to use the pinoutSignals() method to query the current pinout
+    signals set.
 
     Once you know that the ports are ready to read or write, you can
     use the read() or write() methods. Alternatively the
@@ -981,8 +981,7 @@ bool QSerialPort::isRequestToSend()
     \note The serial port has to be open before trying to get the pinout
     signals; otherwise returns NoSignal and sets the NotOpenError error code.
 
-    \sa isDataTerminalReady(), isRequestToSend, setDataTerminalReady(),
-    setRequestToSend()
+    \sa QSerialPort::dataTerminalReady, QSerialPort::requestToSend
 */
 QSerialPort::PinoutSignals QSerialPort::pinoutSignals()
 {