[network-data] fix/update comments on prefix length being in bits (#4678)

include/openthread/ip6.h

@@ -88,7 +88,7 @@ OT_TOOL_PACKED_BEGIN
 struct otIp6Prefix
 {
     otIp6Address mPrefix; ///< The IPv6 prefix.
-    uint8_t      mLength; ///< The IPv6 prefix length.
+    uint8_t      mLength; ///< The IPv6 prefix length (in bits).
 } OT_TOOL_PACKED_END;
 
 /**
@@ -104,7 +104,7 @@ typedef struct otIp6Prefix otIp6Prefix;
 typedef struct otNetifAddress
 {
     otIp6Address           mAddress;                ///< The IPv6 unicast address.
-    uint8_t                mPrefixLength;           ///< The Prefix length.
+    uint8_t                mPrefixLength;           ///< The Prefix length (in bits).
     bool                   mPreferred : 1;          ///< TRUE if the address is preferred, FALSE otherwise.
     bool                   mValid : 1;              ///< TRUE if the address is valid, FALSE otherwise.
     bool                   mScopeOverrideValid : 1; ///< TRUE if the mScopeOverride value is valid, FALSE otherwise.

src/core/thread/network_data.hpp

@@ -390,7 +390,7 @@ protected:
      * This method returns a pointer to a Prefix TLV in a specified tlvs buffer.
      *
      * @param[in]  aPrefix        A pointer to an IPv6 prefix.
-     * @param[in]  aPrefixLength  The prefix length pointed to by @p aPrefix.
+     * @param[in]  aPrefixLength  The prefix length pointed to by @p aPrefix (in bits).
      * @param[in]  aTlvs          A pointer to a specified tlvs buffer.
      * @param[in]  aTlvsLength    The specified tlvs buffer length pointed to by @p aTlvs.
      *

src/core/thread/network_data_local.hpp

@@ -1,3 +1,4 @@
+
 /*
  *  Copyright (c) 2016, The OpenThread Authors.
  *  All rights reserved.
@@ -73,7 +74,7 @@ public:
      * This method adds a Border Router entry to the Thread Network Data.
      *
      * @param[in]  aPrefix        A pointer to the prefix.
-     * @param[in]  aPrefixLength  The length of @p aPrefix in bytes.
+     * @param[in]  aPrefixLength  The prefix length in bits.
      * @param[in]  aPrf           The preference value.
      * @param[in]  aFlags         The Border Router Flags value.
      * @param[in]  aStable        The Stable value.
@@ -89,7 +90,7 @@ public:
      * This method removes a Border Router entry from the Thread Network Data.
      *
      * @param[in]  aPrefix        A pointer to the prefix.
-     * @param[in]  aPrefixLength  The length of @p aPrefix in bytes.
+     * @param[in]  aPrefixLength  The prefix length in bits.
      *
      * @retval OT_ERROR_NONE       Successfully removed the Border Router entry.
      * @retval OT_ERROR_NOT_FOUND  Could not find the Border Router entry.
@@ -101,7 +102,7 @@ public:
      * This method adds a Has Route entry to the Thread Network data.
      *
      * @param[in]  aPrefix        A pointer to the prefix.
-     * @param[in]  aPrefixLength  The length of @p aPrefix in bytes.
+     * @param[in]  aPrefixLength  The prefix length in bits.
      * @param[in]  aPrf           The preference value.
      * @param[in]  aStable        The Stable value.
      *
@@ -115,7 +116,7 @@ public:
      * This method removes a Border Router entry from the Thread Network Data.
      *
      * @param[in]  aPrefix        A pointer to the prefix.
-     * @param[in]  aPrefixLength  The length of @p aPrefix in bytes.
+     * @param[in]  aPrefixLength  The prefix length in bits.
      *
      * @retval OT_ERROR_NONE       Successfully removed the Border Router entry.
      * @retval OT_ERROR_NOT_FOUND  Could not find the Border Router entry.

src/core/thread/network_data_tlvs.hpp

@@ -319,7 +319,7 @@ public:
      * This method initializes the TLV.
      *
      * @param[in]  aDomainId      The Domain ID.
-     * @param[in]  aPrefixLength  The Prefix Length
+     * @param[in]  aPrefixLength  The Prefix Length in bits.
      * @param[in]  aPrefix        A pointer to the prefix.
      *
      */
@@ -358,7 +358,7 @@ public:
     /**
      * This method returns the Prefix Length value.
      *
-     * @returns The Prefix Length value.
+     * @returns The Prefix Length value (in bits).
      *
      */
     uint8_t GetPrefixLength(void) const { return mPrefixLength; }

src/lib/spinel/spinel.h

@@ -2782,7 +2782,7 @@ enum
      * Array of structures containing:
      *
      *  `6`: IPv6 Address
-     *  `C`: Network Prefix Length
+     *  `C`: Network Prefix Length (in bits)
      *  `L`: Valid Lifetime
      *  `L`: Preferred Lifetime
      *