From 697ad17ed18281913e9db78a4beb74ce8d0f4e5f Mon Sep 17 00:00:00 2001
From: Martine Lenders <m.lenders@fu-berlin.de>
Date: Wed, 14 Nov 2018 16:24:30 +0100
Subject: [PATCH] icmpv6_error: doc: provide better references to error codes
---
sys/include/net/gnrc/icmpv6/error.h | 7 ++++---
sys/include/net/icmpv6.h | 3 +++
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/sys/include/net/gnrc/icmpv6/error.h b/sys/include/net/gnrc/icmpv6/error.h
index 8306b99f17..552c93be34 100644
--- a/sys/include/net/gnrc/icmpv6/error.h
+++ b/sys/include/net/gnrc/icmpv6/error.h
@@ -38,7 +38,7 @@ extern "C" {
*
* @pre @p orig_pkt contains a packet snip of type @ref GNRC_NETTYPE_IPV6
*
- * @param[in] code The code for the message @see net/icmpv6.h.
+ * @param[in] code The [code for the message](@ref net_icmpv6_error_dst_unr_codes).
* @param[in] orig_pkt The invoking packet.
*/
void gnrc_icmpv6_error_dst_unr_send(uint8_t code, const gnrc_pktsnip_t *orig_pkt);
@@ -59,7 +59,7 @@ void gnrc_icmpv6_error_pkt_too_big_send(uint32_t mtu,
*
* @pre @p orig_pkt contains a packet snip of type @ref GNRC_NETTYPE_IPV6
*
- * @param[in] code The code for the message @see net/icmpv6.h.
+ * @param[in] code The [code for the message](@ref net_icmpv6_error_time_exc_codes).
* @param[in] orig_pkt The invoking packet.
*/
void gnrc_icmpv6_error_time_exc_send(uint8_t code,
@@ -71,7 +71,8 @@ void gnrc_icmpv6_error_time_exc_send(uint8_t code,
* @pre @p orig_pkt is in receive order.
* @pre @p orig_pkt contains a packet snip of type @ref GNRC_NETTYPE_IPV6
*
- * @param[in] code The code for the message @see net/icmpv6.h.
+ *
+ * @param[in] code The [code for the message](@ref net_icmpv6_error_param_prob_codes).
* @param[in] ptr Pointer to the errorneous octet in @p orig_pkt.
* @param[in] orig_pkt The invoking packet.
*/
diff --git a/sys/include/net/icmpv6.h b/sys/include/net/icmpv6.h
index 3a9e606e16..29d0bec7e0 100644
--- a/sys/include/net/icmpv6.h
+++ b/sys/include/net/icmpv6.h
@@ -75,6 +75,7 @@ extern "C" {
* @{
* @name Codes for destination unreachable messages
*
+ * @anchor net_icmpv6_error_dst_unr_codes
* @see <a href="https://tools.ietf.org/html/rfc4443#section-3.1">
* RFC 4443, section 3.1
* </a>
@@ -97,6 +98,7 @@ extern "C" {
* @{
* @name Codes for time exceeded messages
*
+ * @anchor net_icmpv6_error_time_exc_codes
* @see <a href="https://tools.ietf.org/html/rfc4443#section-3.3">
* RFC 4443, section 3.3
* </a>
@@ -111,6 +113,7 @@ extern "C" {
* @{
* @name Codes for parameter problem messages
*
+ * @anchor net_icmpv6_error_param_prob_codes
* @see <a href="https://tools.ietf.org/html/rfc4443#section-3.4">
* RFC 4443, section 3.4
* </a>
--
GitLab