diff options
author | Alex Blasche <alexander.blasche@qt.io> | 2016-11-15 14:22:37 +0100 |
---|---|---|
committer | Alex Blasche <alexander.blasche@qt.io> | 2016-11-16 06:34:41 +0000 |
commit | a31a7e0b2b7b3de3e1867ad954ac7fad9531cc99 (patch) | |
tree | b44ef14bc45baae29d904189cc1ef758945c5bbb | |
parent | b0c921c4b53b8ddf865e319f1ea1ad49e5933a93 (diff) |
Unify the \since base line version for qdoc
The first stable API release is Qt 5.8. It makes no sense to document
the changes before 5.8. Furthermore the meaning of \since 5.8 before this
tag was rather unknown. It could have meant the function was changed or added.
This double meaning disappears once a compatibility statement is in place.
Change-Id: I047e15bdd92a8c1034947b9b6d03439a293af318
Reviewed-by: Rolf Eike Beer <eb@emlix.com>
Reviewed-by: André Hartmann <aha_1980@gmx.de>
-rw-r--r-- | src/serialbus/qcanbus.cpp | 6 | ||||
-rw-r--r-- | src/serialbus/qcanbusdevice.cpp | 6 | ||||
-rw-r--r-- | src/serialbus/qcanbusfactory.cpp | 4 | ||||
-rw-r--r-- | src/serialbus/qcanbusframe.cpp | 10 | ||||
-rw-r--r-- | src/serialbus/qmodbusclient.cpp | 2 | ||||
-rw-r--r-- | src/serialbus/qmodbusdataunit.cpp | 4 | ||||
-rw-r--r-- | src/serialbus/qmodbusdevice.cpp | 2 | ||||
-rw-r--r-- | src/serialbus/qmodbusdeviceidentification.cpp | 2 | ||||
-rw-r--r-- | src/serialbus/qmodbuspdu.cpp | 8 | ||||
-rw-r--r-- | src/serialbus/qmodbusreply.cpp | 2 | ||||
-rw-r--r-- | src/serialbus/qmodbusrtuserialslave.cpp | 2 | ||||
-rw-r--r-- | src/serialbus/qmodbusserver.cpp | 2 | ||||
-rw-r--r-- | src/serialbus/qmodbustcpclient.cpp | 2 | ||||
-rw-r--r-- | src/serialbus/qmodbustcpserver.cpp | 2 |
14 files changed, 20 insertions, 34 deletions
diff --git a/src/serialbus/qcanbus.cpp b/src/serialbus/qcanbus.cpp index 207cd2b..3e1704c 100644 --- a/src/serialbus/qcanbus.cpp +++ b/src/serialbus/qcanbus.cpp @@ -87,7 +87,7 @@ static void loadPlugins() /*! \class QCanBus \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QCanBus class handles registration and creation of bus plugins. @@ -107,8 +107,6 @@ QCanBus *QCanBus::instance() } /*! - \since 5.8 - Returns a list of identifiers for all loaded plugins. */ QStringList QCanBus::plugins() const @@ -125,8 +123,6 @@ static void setErrorMessage(QString *result, const QString &message) } /*! - \since 5.8 - Creates a CAN bus device. \a plugin is the name of the plugin as returned by the \l plugins() method. \a interfaceName is the CAN bus interface name. In case of failure, the optional parameter \a errorMessage returns a textual error description. diff --git a/src/serialbus/qcanbusdevice.cpp b/src/serialbus/qcanbusdevice.cpp index c20d8a4..bfdb922 100644 --- a/src/serialbus/qcanbusdevice.cpp +++ b/src/serialbus/qcanbusdevice.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE /*! \class QCanBusDevice \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QCanBusDevice class is the interface class for CAN bus. @@ -114,7 +114,7 @@ QT_BEGIN_NAMESPACE /*! \class QCanBusDevice::Filter \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QCanBusDevice::Filter struct defines a filter for CAN bus messages. @@ -429,7 +429,6 @@ qint64 QCanBusDevice::framesToWrite() const or \l errorOccurred() signals. \sa waitForFramesReceived() - \since 5.8 */ bool QCanBusDevice::waitForFramesWritten(int msecs) { @@ -483,7 +482,6 @@ bool QCanBusDevice::waitForFramesWritten(int msecs) or \l errorOccurred() signals. \sa waitForFramesWritten() - \since 5.8 */ bool QCanBusDevice::waitForFramesReceived(int msecs) { diff --git a/src/serialbus/qcanbusfactory.cpp b/src/serialbus/qcanbusfactory.cpp index 7fdbcca..b3df416 100644 --- a/src/serialbus/qcanbusfactory.cpp +++ b/src/serialbus/qcanbusfactory.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \class QCanBusFactory \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QCanBusFactory class is a factory class used as the plugin interface for CAN bus plugins. @@ -59,8 +59,6 @@ QT_BEGIN_NAMESPACE \a errorMessage contains an error description in case of failure. If the factory cannot create a plugin, it returns \c nullptr. - - \since 5.8 */ /*! diff --git a/src/serialbus/qcanbusframe.cpp b/src/serialbus/qcanbusframe.cpp index 2bcc433..89c8612 100644 --- a/src/serialbus/qcanbusframe.cpp +++ b/src/serialbus/qcanbusframe.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE /*! \class QCanBusFrame \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief QCanBusFrame is a container class representing a single CAN frame. @@ -55,14 +55,12 @@ QT_BEGIN_NAMESPACE /*! \fn QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameType type = DataFrame) - \since 5.8 Constructs a CAN frame of the specified \a type. */ /*! \fn QCanBusFrame::QCanBusFrame(quint32 identifier, const QByteArray &data) - \since 5.8 Constructs a CAN frame using \a identifier as the frame identifier and \a data as the payload. */ @@ -113,7 +111,6 @@ QT_BEGIN_NAMESPACE /*! \fn QCanBusFrame::setTimeStamp(TimeStamp ts) - \since 5.8 Sets \a ts as the timestamp for the CAN frame. Usually, this function is not needed, because the timestamp is created during the read operation and not needed during the write operation. @@ -258,7 +255,7 @@ QT_BEGIN_NAMESPACE /*! \class QCanBusFrame::TimeStamp \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The TimeStamp class provides timestamp information with microsecond precision. */ @@ -274,7 +271,6 @@ QT_BEGIN_NAMESPACE /*! \fn static TimeStamp TimeStamp::fromMicroSeconds(qint64 usec) - \since 5.8 Constructs a normalized TimeStamp from microseconds \a usec. @@ -314,8 +310,6 @@ QT_BEGIN_NAMESPACE 123 [5] Remote Request - remote frame with standard identifier 00000234 [0] Remote Request - remote frame with extended identifier \endcode - - \since 5.8 */ QString QCanBusFrame::toString() const { diff --git a/src/serialbus/qmodbusclient.cpp b/src/serialbus/qmodbusclient.cpp index a54f739..fcbad8b 100644 --- a/src/serialbus/qmodbusclient.cpp +++ b/src/serialbus/qmodbusclient.cpp @@ -50,7 +50,7 @@ Q_DECLARE_LOGGING_CATEGORY(QT_MODBUS) /*! \class QModbusClient \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QModbusClient class is the interface to send Modbus requests. diff --git a/src/serialbus/qmodbusdataunit.cpp b/src/serialbus/qmodbusdataunit.cpp index de06bc2..0f8821f 100644 --- a/src/serialbus/qmodbusdataunit.cpp +++ b/src/serialbus/qmodbusdataunit.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \class QModbusDataUnit \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief QModbusDataUnit is a container class representing single bit and \c 16 bit word entries in the Modbus register. @@ -206,7 +206,7 @@ QT_BEGIN_NAMESPACE /*! \typedef QModbusDataUnitMap \relates QModbusDataUnit - \since 5.6 + \since 5.8 Synonym for QMap<QModbusDataUnit::RegisterType, QModbusDataUnit>. */ diff --git a/src/serialbus/qmodbusdevice.cpp b/src/serialbus/qmodbusdevice.cpp index 0eecac7..08718d6 100644 --- a/src/serialbus/qmodbusdevice.cpp +++ b/src/serialbus/qmodbusdevice.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE /*! \class QModbusDevice \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QModbusDevice class is the base class for Modbus classes, \l QModbusServer and \l QModbusClient. diff --git a/src/serialbus/qmodbusdeviceidentification.cpp b/src/serialbus/qmodbusdeviceidentification.cpp index 5ae3f54..3aa54fb 100644 --- a/src/serialbus/qmodbusdeviceidentification.cpp +++ b/src/serialbus/qmodbusdeviceidentification.cpp @@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE /*! \class QModbusDeviceIdentification \inmodule QtSerialBus - \since 5.7 + \since 5.8 \brief The QModbusDeviceIdentification is a container class representing the physical and functional description of a Modbus server. diff --git a/src/serialbus/qmodbuspdu.cpp b/src/serialbus/qmodbuspdu.cpp index d6e1ef9..2b01ad6 100644 --- a/src/serialbus/qmodbuspdu.cpp +++ b/src/serialbus/qmodbuspdu.cpp @@ -184,7 +184,7 @@ static QDataStream &pduFromStream(QDataStream &stream, QModbusPdu &pdu, Type typ /*! \class QModbusPdu \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief QModbusPdu is a abstract container class containing the function code and payload that is stored inside a Modbus ADU. @@ -464,7 +464,7 @@ QDataStream &operator<<(QDataStream &stream, const QModbusPdu &pdu) /*! \class QModbusRequest \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief QModbusRequest is a container class containing the function code and payload that is stored inside a Modbus ADU. @@ -618,7 +618,7 @@ QDataStream &operator>>(QDataStream &stream, QModbusRequest &pdu) /*! \class QModbusResponse \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief QModbusResponse is a container class containing the function code and payload that is stored inside a Modbus ADU. @@ -796,7 +796,7 @@ QDataStream &operator>>(QDataStream &stream, QModbusResponse &pdu) /*! \class QModbusExceptionResponse \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief QModbusExceptionResponse is a container class containing the function and error code inside a Modbus ADU. diff --git a/src/serialbus/qmodbusreply.cpp b/src/serialbus/qmodbusreply.cpp index 2a8ee19..f88a3bd 100644 --- a/src/serialbus/qmodbusreply.cpp +++ b/src/serialbus/qmodbusreply.cpp @@ -58,7 +58,7 @@ public: /*! \class QModbusReply \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QModbusReply class contains the data for a request sent with a \l QModbusClient derived class. diff --git a/src/serialbus/qmodbusrtuserialslave.cpp b/src/serialbus/qmodbusrtuserialslave.cpp index 644ad07..87698d3 100644 --- a/src/serialbus/qmodbusrtuserialslave.cpp +++ b/src/serialbus/qmodbusrtuserialslave.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE /*! \class QModbusRtuSerialSlave \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QModbusRtuSerialSlave class represents a Modbus server that uses a serial port for its communication with the Modbus client. diff --git a/src/serialbus/qmodbusserver.cpp b/src/serialbus/qmodbusserver.cpp index ffb673a..1a16347 100644 --- a/src/serialbus/qmodbusserver.cpp +++ b/src/serialbus/qmodbusserver.cpp @@ -53,7 +53,7 @@ Q_DECLARE_LOGGING_CATEGORY(QT_MODBUS) /*! \class QModbusServer \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QModbusServer class is the interface to receive and process Modbus requests. diff --git a/src/serialbus/qmodbustcpclient.cpp b/src/serialbus/qmodbustcpclient.cpp index 94fa174..a34c241 100644 --- a/src/serialbus/qmodbustcpclient.cpp +++ b/src/serialbus/qmodbustcpclient.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE /*! \class QModbusTcpClient \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QModbusTcpClient class is the interface class for Modbus TCP client device. diff --git a/src/serialbus/qmodbustcpserver.cpp b/src/serialbus/qmodbustcpserver.cpp index 0f9aff2..07a3363 100644 --- a/src/serialbus/qmodbustcpserver.cpp +++ b/src/serialbus/qmodbustcpserver.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE /*! \class QModbusTcpServer \inmodule QtSerialBus - \since 5.6 + \since 5.8 \brief The QModbusTcpServer class represents a Modbus server that uses a TCP server for its communication with the Modbus client. |