Doc: Update and unify documentation

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

5 files changed, 15 insertions, 15 deletions

diff --git a/src/knx/netip/qknxnetipsecurewrapper.cpp b/src/knx/netip/qknxnetipsecurewrapper.cpp
index 8aa2f18..ca406c8 100644
--- a/src/knx/netip/qknxnetipsecurewrapper.cpp
+++ b/src/knx/netip/qknxnetipsecurewrapper.cpp
@@ -262,7 +262,7 @@ QKnxNetIpSecureWrapperProxy::Builder &
 
 /*!
     Sets the message tag of the generic KNXnet/IP secure wrapper frame to \a tag
-    and returns a reference to builder. By default value is set to \c 0x0000.
+    and returns a reference to the builder. By default value is set to \c 0x0000.
 
     This field contains an arbitrary value to differentiate two KNXnet/IP
     secure wrapper multicast frames sent by one KNXnet/IP device within the
diff --git a/src/knx/netip/qknxnetipsessionauthenticate.cpp b/src/knx/netip/qknxnetipsessionauthenticate.cpp
index 46300f5..12e38b2 100644
--- a/src/knx/netip/qknxnetipsessionauthenticate.cpp
+++ b/src/knx/netip/qknxnetipsessionauthenticate.cpp
@@ -130,7 +130,7 @@ quint8 QKnxNetIpSessionAuthenticateProxy::userId() const
 }
 
 /*!
-    Returns the AES128 CCM message authentication code from the generic
+    Returns the AES128 CCM message authentication code (MAC) from the generic
     KNXnet/IP session authentication frame with a fixed size of \c 16 bytes.
 */
 QKnxByteArray QKnxNetIpSessionAuthenticateProxy::messageAuthenticationCode() const
@@ -218,9 +218,9 @@ QKnxNetIpSessionAuthenticateProxy::Builder &
 }
 
 /*!
-    Sets the AES128 CCM message authentication code of the generic KNXnet/IP
-    session authentication frame to \a data and returns a reference to builder.
-    The message authentication code has a fixed size of \c 16 bytes.
+    Sets the AES128 CCM message authentication code (MAC) of the generic
+    KNXnet/IP session authentication frame to \a data and returns a reference
+    to the builder. The MAC has a fixed size of \c 16 bytes.
 */
 QKnxNetIpSessionAuthenticateProxy::Builder &
     QKnxNetIpSessionAuthenticateProxy::Builder::setMessageAuthenticationCode(const QKnxByteArray &data)
diff --git a/src/knx/netip/qknxnetipsessionresponse.cpp b/src/knx/netip/qknxnetipsessionresponse.cpp
index b9ea89e..341aea3 100644
--- a/src/knx/netip/qknxnetipsessionresponse.cpp
+++ b/src/knx/netip/qknxnetipsessionresponse.cpp
@@ -134,7 +134,7 @@ QKnxByteArray QKnxNetIpSessionResponseProxy::publicKey() const
 }
 
 /*!
-    Returns the AES128 CCM message authentication code from the generic
+    Returns the AES128 CCM message authentication code (MAC) from the generic
     KNXnet/IP session response frame with a fixed size of \c 16 bytes.
 */
 QKnxByteArray QKnxNetIpSessionResponseProxy::messageAuthenticationCode() const
@@ -231,9 +231,9 @@ QKnxNetIpSessionResponseProxy::Builder &
 }
 
 /*!
-    Sets the AES128 CCM message authentication code of the generic KNXnet/IP
-    session response frame to \a data and returns a reference to builder. The
-    message authentication code has a fixed size of \c 16 bytes.
+    Sets the AES128 CCM message authentication code (MAC) of the generic
+    KNXnet/IP session response frame to \a data and returns a reference to the
+    builder. The MAC has a fixed size of \c 16 bytes.
 */
 QKnxNetIpSessionResponseProxy::Builder &
     QKnxNetIpSessionResponseProxy::Builder::setMessageAuthenticationCode(const QKnxByteArray &data)
diff --git a/src/knx/netip/qknxnetipsrp.cpp b/src/knx/netip/qknxnetipsrp.cpp
index 1bf1e49..5a9babf 100644
--- a/src/knx/netip/qknxnetipsrp.cpp
+++ b/src/knx/netip/qknxnetipsrp.cpp
@@ -327,7 +327,7 @@ QKnxNetIpSrpProxy::MacAddress::MacAddress()
 {}
 
 /*!
-    Destroys the builder.
+    Destroys the object and frees any allocated resources.
 */
 QKnxNetIpSrpProxy::MacAddress::~MacAddress()
 {}
diff --git a/src/knx/netip/qknxnetiptimernotify.cpp b/src/knx/netip/qknxnetiptimernotify.cpp
index 495189b..69dd56d 100644
--- a/src/knx/netip/qknxnetiptimernotify.cpp
+++ b/src/knx/netip/qknxnetiptimernotify.cpp
@@ -141,7 +141,7 @@ quint16 QKnxNetIpTimerNotifyProxy::messageTag() const
 }
 
 /*!
-    Returns the AES128 CCM message authentication code from the generic
+    Returns the AES128 CCM message authentication code (MAC) from the generic
     KNXnet/IP secure timer notify frame with a fixed size of \c 16 bytes.
 */
 QKnxByteArray QKnxNetIpTimerNotifyProxy::messageAuthenticationCode() const
@@ -246,7 +246,7 @@ QKnxNetIpTimerNotifyProxy::Builder &
 
 /*!
     Sets the message tag of the generic KNXnet/IP timer notify frame to \a tag
-    and returns a reference to builder.
+    and returns a reference to the builder.
 
     In case of a periodic or initial notify the tag contains a random value. In
     case of an update notify this is the value of the outdated frame triggering
@@ -259,9 +259,9 @@ QKnxNetIpTimerNotifyProxy::Builder &QKnxNetIpTimerNotifyProxy::Builder::setMessa
 }
 
 /*!
-    Sets the AES128 CCM message authentication code of the generic KNXnet/IP
-    timer notify frame to \a data and returns a reference to builder. The
-    message authentication code has a fixed size of \c 16 bytes.
+    Sets the AES128 CCM message authentication code (MAC) of the generic
+    KNXnet/IP timer notify frame to \a data and returns a reference to the
+    builder. The MAC has a fixed size of \c 16 bytes.
 */
 QKnxNetIpTimerNotifyProxy::Builder &
     QKnxNetIpTimerNotifyProxy::Builder::setMessageAuthenticationCode(const QKnxByteArray &data)