Merge pull request #11965 from pokgak/credman-add-credential-type-docs

credman: add documentation for enum credman_type_t
RIOT-OS · Aug 7, 2019 · a06b84d · a06b84d
2 parents 1e7a468 + 0c542f6
commit a06b84d
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/sys/include/net/credman.h b/sys/include/net/credman.h
@@ -90,9 +90,14 @@ typedef uint16_t credman_tag_t;
  * @brief Credential types
  */
 typedef enum {
+    /**
+     * @brief Empty type
+     *
+     * Used to detect uninitialized @ref credman_credential_t internally.
+     */
     CREDMAN_TYPE_EMPTY  = 0,
-    CREDMAN_TYPE_PSK    = 1,
-    CREDMAN_TYPE_ECDSA  = 2,
+    CREDMAN_TYPE_PSK    = 1,    /**< PSK credential type */
+    CREDMAN_TYPE_ECDSA  = 2,    /**< ECDSA credential type */
 } credman_type_t;
 
 /**