michaelh/zephyr
1
0
Fork 0
Code Releases Activity

net: doc: Add missing defgroups to network header files

Browse source 
Some of the networking header files in include/net/ directory were
missing @defgroup doxygen directives.

There was also duplicate @defgroup directives which are now changed
to @addtogroup directives.

Added also missing API links to doc/api/networking.rst file.

Added exceptions to .known-issues/doc/networking.conf file so that
doxygen does not complain.

Jira: ZEP-2308

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2017-07-20 16:29:45 +03:00
commit 539b0c46ff
21 changed files with 335 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/net/net_core.h
View file

@ -17,6 +17,12 @@
extern "C" {
#endif
/**
* @brief Network core library
* @defgroup net_core Network Core Library
* @{
*/
/* Network subsystem logging helpers */
#if defined(NET_LOG_ENABLED)
@ -164,6 +170,10 @@ static inline void net_analyze_stack(const char *name,
#endif
/* @endcond */
/**
* @}
*/
#ifdef __cplusplus
}
#endif