michaelh/zephyr
1
0
Fork 0
Code Releases Activity

net: Hide internal code from documentation

Browse source 
No need to add internal code into public documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-14 16:12:24 +02:00 • committed by Anas Nashif
commit b288a9d4e5
9 changed files with 73 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
include/net/net_core.h
View file

@ -33,6 +33,8 @@ extern "C" {
* @{
*/
/** @cond INTERNAL_HIDDEN */
/* Network subsystem logging helpers */
#include <logging/log.h>
@ -47,6 +49,8 @@ extern "C" {
#define NET_ASSERT(cond) __ASSERT_NO_MSG(cond)
#define NET_ASSERT_INFO(cond, fmt, ...) __ASSERT(cond, fmt, ##__VA_ARGS__)
/** @endcond */
#include <kernel.h>
struct net_buf;
@ -83,6 +87,7 @@ int net_recv_data(struct net_if *iface, struct net_pkt *pkt);
*/
int net_send_data(struct net_pkt *pkt);
/** @cond INTERNAL_HIDDEN */
/*
* The net_stack_info struct needs to be aligned to 32 byte boundary,
* otherwise the __net_stack_end will point to wrong location and looping
@ -168,7 +173,6 @@ struct net_stack_info {
#define NET_STACK_DEFINE_EMBEDDED(name, size) char name[size]
/** @cond ignore */
#if defined(CONFIG_INIT_STACKS)
#include <misc/stack.h>
@ -189,7 +193,6 @@ void net_analyze_stack(const char *name, const char *stack, size_t size);
#define net_analyze_stack(...)
#define net_analyze_stack_get_values(...)
#endif
/* @endcond */
/* Some helper defines for traffic class support */
#if defined(CONFIG_NET_TC_TX_COUNT) && defined(CONFIG_NET_TC_RX_COUNT)
@ -207,6 +210,8 @@ void net_analyze_stack(const char *name, const char *stack, size_t size);
#define NET_TC_COUNT 1
#endif /* CONFIG_NET_TC_TX_COUNT && CONFIG_NET_TC_RX_COUNT */
/* @endcond */
/**
* @}
*/