Doc: Mark the docs for the TPDU factories internal

Change-Id: If24d1c05cc8c7b3470cca5913952750624566369
Reviewed-by: Karsten Heimrich <karsten.heimrich@qt.io>

3 files changed, 44 insertions, 0 deletions

diff --git a/src/knx/qknxtpdufactory_broadcast.cpp b/src/knx/qknxtpdufactory_broadcast.cpp
index 89751fd..c700863 100644
--- a/src/knx/qknxtpdufactory_broadcast.cpp
+++ b/src/knx/qknxtpdufactory_broadcast.cpp
@@ -33,6 +33,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QKnxTpduFactory::Broadcast
+    \internal
 
     \inmodule QtKnx
     \brief The QKnxTpduFactory::Broadcast class is used to create a valid
@@ -154,6 +155,8 @@ QKnxTpduFactory::Broadcast::createSystemNetworkParameterWriteTpdu(QKnxInterfaceO
 // -- A_IndividualAddress
 
 /*!
+    \internal
+
     Returns a TPDU for Individual Address Read Application Service.
 */
 QKnxTpdu QKnxTpduFactory::Broadcast::createIndividualAddressReadTpdu()
@@ -163,6 +166,8 @@ QKnxTpdu QKnxTpduFactory::Broadcast::createIndividualAddressReadTpdu()
 }
 
 /*!
+    \internal
+
     Returns a TPDU for Individual Address Write Application Service with the
     given \l QKnxAddress \a address; or an empty TPDU if the \a address is not
     of type \l QKnxAddress::Individual.
@@ -188,6 +193,8 @@ QKnxTpduFactory::Broadcast::createIndividualAddressResponseTpdu()
 // -- A_IndividualAddressSerialNumber
 
 /*!
+    \internal
+
     Returns a TPDU for Individual Address Serial Number Read Application Service
     with the given \a sn set; or an empty TPDU if the \a sn
     has a different size then six octets.
@@ -217,6 +224,8 @@ QKnxTpduFactory::Broadcast::createIndividualAddressSerialNumberResponseTpdu(cons
 }
 
 /*!
+    \internal
+
     Returns a TPDU for Individual Address Serial Number Write Application Service
     with the given \a sn and \l QKnxAddress \a newAddress set; or otherwise an
     empty TPDU if the \a sn has a different size then six octets or the type of
@@ -239,6 +248,8 @@ QKnxTpduFactory::Broadcast::createIndividualAddressSerialNumberWriteTpdu(const Q
 // -- A_DomainAddress
 
 /*!
+    \internal
+
     Returns a TPDU for Domain Address Read Application Service.
 */
 QKnxTpdu QKnxTpduFactory::Broadcast::createDomainAddressReadTpdu()
@@ -258,6 +269,8 @@ QKnxTpdu QKnxTpduFactory::Broadcast::createDomainAddressResponseTpdu(const QKnxB
 }
 
 /*!
+    \internal
+
     Returns a TPDU for Domain Address Write Application Service with the given
     \l QKnxAddress \a address set.
 */
@@ -275,6 +288,8 @@ QKnxTpdu QKnxTpduFactory::Broadcast::createDomainAddressWriteTpdu(const QKnxByte
 // -- A_CreateDomainAddressSerialNumber
 
 /*!
+    \internal
+
     Returns a TPDU for Domain Address Serial Number Read Application Service
     with the given \a sn set; or an empty TPDU if the \a sn has a different size
     then six octets.
@@ -303,6 +318,8 @@ QKnxTpduFactory::Broadcast::createDomainAddressSerialNumberResponseTpdu(const QK
 }
 
 /*!
+    \internal
+
     Returns a TPDU for Domain Address Serial Number Write Application Service
     with the given \a sn and \l QKnxAddress \a domainAddress set; or otherwise
     an empty TPDU if the \a sn has a different size then six octets.
diff --git a/src/knx/qknxtpdufactory_multicast.cpp b/src/knx/qknxtpdufactory_multicast.cpp
index e7a4915..adb67f4 100644
--- a/src/knx/qknxtpdufactory_multicast.cpp
+++ b/src/knx/qknxtpdufactory_multicast.cpp
@@ -33,6 +33,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QKnxTpduFactory::Multicast
+    \internal
 
     \inmodule QtKnx
     \brief The QKnxTpduFactory::Broadcast class is used to create a valid
@@ -46,6 +47,8 @@ QT_BEGIN_NAMESPACE
 // -- A_GroupValue
 
 /*!
+    \internal
+
     Returns a TPDU for a Group value read application service.
 */
 QKnxTpdu QKnxTpduFactory::Multicast::createGroupValueReadTpdu()
@@ -55,6 +58,8 @@ QKnxTpdu QKnxTpduFactory::Multicast::createGroupValueReadTpdu()
 }
 
 /*!
+    \internal
+
     Creates and returns a TPDU for a Group value response application service
     with the given \a data.
 */
@@ -69,6 +74,8 @@ QKnxTpdu QKnxTpduFactory::Multicast::createGroupValueResponseTpdu(const QKnxByte
 }
 
 /*!
+    \internal
+
     Creates and returns a TPDU for a Group value write application service with
     the given \a data.
 */
diff --git a/src/knx/qknxtpdufactory_p2p.cpp b/src/knx/qknxtpdufactory_p2p.cpp
index b7df7b9..0bcea5a 100644
--- a/src/knx/qknxtpdufactory_p2p.cpp
+++ b/src/knx/qknxtpdufactory_p2p.cpp
@@ -34,6 +34,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QKnxTpduFactory
+    \internal
 
     \inmodule QtKnx
     \brief The QKnxTpduFactory class is used to create a valid Transport protocol
@@ -65,6 +66,7 @@ static QKnxTpdu::TransportControlField tpci(QKnxTpduFactory::PointToPoint::Mode
 
 /*!
     \class QKnxTpduFactory::PointToPoint
+    \internal
 
     \inmodule QtKnx
     \brief The QKnxTpduFactory::PointToPoint class is used to create a valid
@@ -80,6 +82,8 @@ static QKnxTpdu::TransportControlField tpci(QKnxTpduFactory::PointToPoint::Mode
 */
 
 /*!
+    \internal
+
     \enum QKnxTpduFactory::PointToPoint::Mode
 
     \value Connectionless,
@@ -325,6 +329,7 @@ QKnxTpdu QKnxTpduFactory::PointToPoint::createFileStreamInfoReportTpdu(Mode mode
 
 /*!
     \class QKnxTpduFactory::PointToPointConnectionless
+    \internal
 
     \inmodule QtKnx
     \brief The QKnxTpduFactory::PointToPointConnectionless class is used to
@@ -384,6 +389,7 @@ QKnxTpduFactory::PointToPointConnectionless::createNetworkParameterWriteTpdu(QKn
 
 /*!
     \class QKnxTpduFactory::PointToPointConnectionOriented
+    \internal
 
     \inmodule QtKnx
     \brief The QKnxTpduFactory::PointToPointConnectionOriented class is used to
@@ -398,6 +404,8 @@ QKnxTpduFactory::PointToPointConnectionless::createNetworkParameterWriteTpdu(QKn
 */
 
 /*!
+    \internal
+
     Returns a TPDU for Memory Read Application Service with the given \a number,
     \a address and sequence number \a seqNumber set.
 */
@@ -410,6 +418,8 @@ QKnxTpdu QKnxTpduFactory::PointToPointConnectionOriented::createMemoryReadTpdu(q
 }
 
 /*!
+    \internal
+
     Returns a TPDU for Memory Response Application Service with the given
     \a number, \a address, \a data and sequence number \a seqNumber set.
 */
@@ -426,6 +436,8 @@ QKnxTpdu QKnxTpduFactory::PointToPointConnectionOriented::createMemoryResponseTp
 }
 
 /*!
+    \internal
+
     Returns a TPDU for Memory Write Application Service with the given
     \a number, \a address, \a data and sequence number \a seqNumber set.
 */
@@ -442,6 +454,8 @@ QKnxTpdu QKnxTpduFactory::PointToPointConnectionOriented::createMemoryWriteTpdu(
 }
 
 /*!
+    \internal
+
     Returns a \l QKnxTpdu for ADC Read Application Service with the given
     \a channel, \a readCount and \a seqNumber set.
 */
@@ -471,6 +485,8 @@ QKnxTpdu QKnxTpduFactory::PointToPointConnectionOriented::createAdcResponseTpdu(
 }
 
 /*!
+    \internal
+
     Returns a \l QKnxTpdu for User Memory Read Application Service with
     \a addressExtention, \a number, \a address and sequence number \a seqNumber
     set.
@@ -505,6 +521,8 @@ QKnxTpduFactory::PointToPointConnectionOriented::createUserMemoryResponseTpdu(qu
 }
 
 /*!
+    \internal
+
     Returns a TPDU for User Memory Write Application Service with
     \a addressExtention, \a number, \a address, \a data and \a seqNumber
     set.
@@ -525,6 +543,8 @@ QKnxTpduFactory::PointToPointConnectionOriented::createUserMemoryWriteTpdu(quint
 }
 
 /*!
+    \internal
+
     Returns a TPDU for User Manufacturer Info Read Application Service with the
     given sequence number \a seqNumber set.
 */