michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: net: Hide UDP API documentation

Browse source 
The UDP API functions are for Zephyr internal use only so do
not generate documentation for them.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-20 13:00:28 +02:00 • committed by Anas Nashif
commit db45ed716f
3 changed files with 7 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/reference/networking/index.rst
View file

@ -31,4 +31,3 @@ Networking
ptp_time.rst ptp_time.rst
traffic-class.rst traffic-class.rst
trickle.rst trickle.rst
udp.rst

14
doc/reference/networking/udp.rst
View file

@ -1,14 +0,0 @@
.. _udp_interface:
UDP
###
Overview
********
API Reference
*************
.. doxygengroup:: udp
:project: Zephyr

7
include/net/udp.h
View file

@ -21,6 +21,11 @@
extern "C" { extern "C" {
#endif #endif
/* These APIs are mostly meant for Zephyr internal use so do not generate
* documentation for them.
*/
/** @cond INTERNAL_HIDDEN */
/** /**
* @brief UDP library * @brief UDP library
* @defgroup udp UDP Library * @defgroup udp UDP Library
@ -86,6 +91,8 @@ static inline struct net_udp_hdr *net_udp_set_hdr(struct net_pkt *pkt,
* @} * @}
*/ */
/** @endcond */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif