From 1993b0257ca7ac07f0543a09f015c9528a8438f6 Mon Sep 17 00:00:00 2001
From: Dirk Ziegelmeier <dirk@ziegelmeier.net>
Date: Wed, 27 Jul 2016 06:37:26 +0200
Subject: [PATCH] Document SNMP MIB2 functions

---
 src/apps/snmp/snmp_mib2.c        |  5 +++++
 src/apps/snmp/snmp_mib2_system.c | 21 +++++++++++++++++----
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/src/apps/snmp/snmp_mib2.c b/src/apps/snmp/snmp_mib2.c
index 99943886..9d8c43c1 100644
--- a/src/apps/snmp/snmp_mib2.c
+++ b/src/apps/snmp/snmp_mib2.c
@@ -33,6 +33,11 @@
  *         Christiaan Simons <christiaan.simons@axon.tv>
  */
 
+/**
+ * @defgroup snmp_mib2 MIB2
+ * @ingroup snmp
+ */
+
 #include "lwip/apps/snmp_opts.h"
 
 #if LWIP_SNMP && SNMP_LWIP_MIB2 /* don't build if not configured for use in lwipopts.h */
diff --git a/src/apps/snmp/snmp_mib2_system.c b/src/apps/snmp/snmp_mib2_system.c
index 53707ee8..2cf88486 100644
--- a/src/apps/snmp/snmp_mib2_system.c
+++ b/src/apps/snmp/snmp_mib2_system.c
@@ -86,6 +86,7 @@ static u16_t*       syslocation_wr_len        = NULL; /* if writable, points to
 static u16_t        syslocation_bufsize       = 0;    /* 0=not writable */
 
 /**
+ * @ingroup snmp_mib2
  * Initializes sysDescr pointers.
  *
  * @param str if non-NULL then copy str pointer
@@ -101,9 +102,10 @@ snmp_mib2_set_sysdescr(const u8_t *str, const u16_t *len)
 }
 
 /**
+ * @ingroup snmp_mib2
  * Initializes sysContact pointers
  *
- *  * @param ocstr if non-NULL then copy str pointer
+ * @param ocstr if non-NULL then copy str pointer
  * @param ocstrlen points to string length, excluding zero terminator. 
  *        if set to NULL it is assumed that ocstr is NULL-terminated.
  * @param bufsize size of the buffer in bytes.
@@ -124,7 +126,10 @@ snmp_mib2_set_syscontact(u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)
   }
 }
 
-/** see \ref snmp_mib2_set_syscontact but set pointer to readonly memory */
+/**
+ * @ingroup snmp_mib2
+ * see \ref snmp_mib2_set_syscontact but set pointer to readonly memory
+ */
 void
 snmp_mib2_set_syscontact_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
 {
@@ -139,6 +144,7 @@ snmp_mib2_set_syscontact_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
 
 
 /**
+ * @ingroup snmp_mib2
  * Initializes sysName pointers
  *
  * @param ocstr if non-NULL then copy str pointer
@@ -162,7 +168,10 @@ snmp_mib2_set_sysname(u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)
   }
 }
 
-/** see \ref snmp_mib2_set_sysname but set pointer to readonly memory */
+/**
+ * @ingroup snmp_mib2
+ * see \ref snmp_mib2_set_sysname but set pointer to readonly memory
+ */
 void
 snmp_mib2_set_sysname_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
 {
@@ -176,6 +185,7 @@ snmp_mib2_set_sysname_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
 }
 
 /**
+ * @ingroup snmp_mib2
  * Initializes sysLocation pointers
  *
  * @param ocstr if non-NULL then copy str pointer
@@ -199,7 +209,10 @@ snmp_mib2_set_syslocation(u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)
   }
 }
 
-/** see \ref snmp_mib2_set_syslocation but set pointer to readonly memory */
+/**
+ * @ingroup snmp_mib2
+ * see \ref snmp_mib2_set_syslocation but set pointer to readonly memory
+ */
 void
 snmp_mib2_set_syslocation_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
 {