network: clarify the IPv6 autoconfigured address generation documentation.

This commit is contained in:
Tommaso Pecorella
2018-02-24 20:28:05 -06:00
parent ad5f9374e0
commit f6bdc69a97

View File

@@ -142,6 +142,9 @@ public:
/**
* \brief Make the autoconfigured IPv6 address with Mac16Address.
*
* The EUI-64 scheme used is based on the \RFC{4944}.
*
* \param addr the MAC address (16 bits).
* \param prefix the IPv6 prefix
* \return autoconfigured IPv6 address
@@ -150,6 +153,9 @@ public:
/**
* \brief Make the autoconfigured IPv6 address with Mac48Address.
*
* The EUI-64 scheme used is based on \RFC{2464}.
*
* \param addr the MAC address (48 bits).
* \param prefix the IPv6 prefix
* \return autoconfigured IPv6 address
@@ -157,7 +163,7 @@ public:
static Ipv6Address MakeAutoconfiguredAddress (Mac48Address addr, Ipv6Address prefix);
/**
* \brief Make the autoconfigured IPv6 address with Mac48Address.
* \brief Make the autoconfigured IPv6 address with Mac64Address.
* \param addr the MAC address (64 bits).
* \param prefix the IPv6 prefix
* \return autoconfigured IPv6 address
@@ -166,6 +172,9 @@ public:
/**
* \brief Make the autoconfigured IPv6 address with Mac8Address.
*
* The EUI-64 scheme used is loosely based on the \RFC{2464}.
*
* \param addr the Mac8Address address (8 bits).
* \param prefix the IPv6 prefix
* \return autoconfigured IPv6 address
@@ -174,6 +183,9 @@ public:
/**
* \brief Make the autoconfigured link-local IPv6 address with Mac16Address.
*
* The EUI-64 scheme used is based on the \RFC{4944}.
*
* \param mac the MAC address (16 bits).
* \return autoconfigured link-local IPv6 address
*/
@@ -181,13 +193,16 @@ public:
/**
* \brief Make the autoconfigured link-local IPv6 address with Mac48Address.
*
* The EUI-64 scheme used is based on \RFC{2464}.
*
* \param mac the MAC address (48 bits).
* \return autoconfigured link-local IPv6 address
*/
static Ipv6Address MakeAutoconfiguredLinkLocalAddress (Mac48Address mac);
/**
* \brief Make the autoconfigured link-local IPv6 address with Mac48Address.
* \brief Make the autoconfigured link-local IPv6 address with Mac64Address.
* \param mac the MAC address (64 bits).
* \return autoconfigured link-local IPv6 address
*/
@@ -195,6 +210,9 @@ public:
/**
* \brief Make the autoconfigured link-local IPv6 address with Mac8Address.
*
* The EUI-64 scheme used is loosely based on the \RFC{2464}.
*
* \param mac the MAC address (8 bits).
* \return autoconfigured link-local IPv6 address
*/