From 11828bf66b02629a743b7d71b1d808c2e7b1cb1f Mon Sep 17 00:00:00 2001
From: Anas Nashif <anas.nashif@intel.com>
Date: Sun, 25 Feb 2018 08:31:17 -0600
Subject: [PATCH] doc: do not show undocumented members

Avoid listing internal function in the public API documentation. After
enabling those doxygen configs, we go lots of errors and bad refs that
were fixed.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
---
 include/gpio.h           |  3 +++
 include/i2s.h            |  3 +++
 include/init.h           | 12 +++++++++---
 include/misc/stack.h     |  9 ++++++++-
 include/net/mqtt_types.h |  3 +++
 include/net/net_core.h   |  3 +++
 6 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/include/gpio.h b/include/gpio.h
index e04b907cb1e..76d28c95dc8 100644
--- a/include/gpio.h
+++ b/include/gpio.h
@@ -532,6 +532,9 @@ static inline int gpio_port_disable_callback(struct device *port)
  */
 __syscall int gpio_get_pending_int(struct device *dev);
 
+/**
+ * @internal
+ */
 static inline int _impl_gpio_get_pending_int(struct device *dev)
 {
 	struct gpio_driver_api *api;
diff --git a/include/i2s.h b/include/i2s.h
index c8f634ce28c..4e37be44199 100644
--- a/include/i2s.h
+++ b/include/i2s.h
@@ -176,6 +176,9 @@ typedef u8_t i2s_opt_t;
 #define I2S_OPT_LOOPBACK                    (1 << 7)
 
 
+/**
+ * @brief I2C Direction
+ */
 enum i2s_dir {
 	/** Receive data */
 	I2S_DIR_RX,
diff --git a/include/init.h b/include/init.h
index 337d1b5f251..e0e58ae38dc 100644
--- a/include/init.h
+++ b/include/init.h
@@ -55,10 +55,16 @@ extern "C" {
  * @brief Run an initialization function at boot at specified priority,
  * and define device PM control function.
  *
- * @copydetails SYS_INIT
- * @param pm_control_fn Pointer to device_pm_control function.
- * Can be empty function (device_pm_control_nop) if not implemented.
+ * @details This macro lets you run a function at system boot.
+ *
  * @param drv_name Name of this system device
+ * @param init_fn Pointer to the boot function to run
+ * @param pm_control_fn Pointer to device_pm_control function.
+ *                      Can be empty function (device_pm_control_nop) if not
+ *                      implemented.
+ * @param level The initialization level, See DEVICE_INIT for details.
+ * @param prio Priority within the selected initialization level. See
+ * 	       DEVICE_INIT for details.
  */
 #define SYS_DEVICE_DEFINE(drv_name, init_fn, pm_control_fn, level, prio) \
 	DEVICE_DEFINE(_SYS_NAME(init_fn), drv_name, init_fn, pm_control_fn, \
diff --git a/include/misc/stack.h b/include/misc/stack.h
index 8b40c8ce173..159607dfbca 100644
--- a/include/misc/stack.h
+++ b/include/misc/stack.h
@@ -79,7 +79,14 @@ static inline void stack_analyze(const char *name, const char *stack,
 {
 }
 #endif
-
+/**
+ * @brief Analyze stacks
+ *
+ * Use this macro to get information about stack usage
+ *
+ * @param name Name of the stack
+ * @param sym The symbol of the stack
+ */
 #define STACK_ANALYZE(name, sym) \
 	stack_analyze(name, K_THREAD_STACK_BUFFER(sym), \
 		      K_THREAD_STACK_SIZEOF(sym))
diff --git a/include/net/mqtt_types.h b/include/net/mqtt_types.h
index 5db527fae8a..4e65642f8d6 100644
--- a/include/net/mqtt_types.h
+++ b/include/net/mqtt_types.h
@@ -74,6 +74,9 @@ struct mqtt_connect_msg {
 	u16_t password_len;
 };
 
+/**
+ * @brief MQTT Publish Message
+ */
 struct mqtt_publish_msg {
 	u8_t dup;
 	enum mqtt_qos qos;
diff --git a/include/net/net_core.h b/include/net/net_core.h
index a44c9835370..f3f8fa94078 100644
--- a/include/net/net_core.h
+++ b/include/net/net_core.h
@@ -78,6 +78,9 @@ struct net_if;
 #include <logging/sys_log.h>
 #include <string.h>
 
+/**
+ * @brief Net Verdict
+ */
 enum net_verdict {
 	NET_OK,		/** Packet has been taken care of */
 	NET_CONTINUE,	/** Packet has not been touched,