michaelh/zephyr
1
0
Fork 0
Code Releases Activity
134,760 commits 140 branches 0 tags 736 MiB
Commit graph

17,121 commits

Author SHA1 Message Date
Jukka Rissanen
97979604de net: doc: socket_types.h: Hide internal data from documentation 
No need to generate documentation for internal data.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
d433c9cc17 net: doc: socket_service.h: Hide internal documentation 
Do not add internal symbols to generated documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
b1956dfa08 net: doc: socket_select.h: Hide internal data from documentation 
No need to generate public documentation for internal data.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
77a8f1b105 net: doc: socket_offload.h: Improve documentation 
Fix the socket_offload.h header file documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
f8a3c95132 net: doc: socket_net_mgmt.h: Hide internal docs 
No need to generate documentation for internal data.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
b38132113a net: doc: socket.h: Hide internal documentation 
Some of the internal macros can be hidden from generated
documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
8b031c7952 net: doc: sntp.h: Improve documentation 
Fix doxygen documentation in sntp.h header file.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
6a76641619 net: doc: ptp_time.h: Improve documentation 
Fix the documentation in ptp_time.h to improve the documentation
coverage.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
bd0816afea net: doc: ppp.h: Improve PPP documentation 
Some of the symbols in ppp.h were not documented.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
35c64657a1 net: doc: phy.h: Add missing documentation 
Couple of cabatility checking macros were missing documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
c168ef39c0 net: doc: openthread.h: Hide internal symbol 
No need to show internal symbols in generated documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
8fed255da5 net: doc: offloaded_netdev.h: Fix doxygen comment 
The get_type API function was missing doxygen comment.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
5c91793911 net: doc: net_timeout.h: Fix doxygen comments 
Some of the already documented variables were missing proper
doxygen comment.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
2a28a13a6d net: doc: net_stats.h: Improve statistics documentation 
Lot of statistics variables were not documented at all.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
d08c93bbc9 net: doc: net_pkt_filter.h: Improve documentation 
Add more documentation to net_pkt_filter.h header file.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
f1f77046fb net: doc: net_pkt.h: Improve net_pkt documenation 
Add more documentation to net_pkt.h

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
b330357fdc net: doc: net_mgmt.h: Fix net_mgmt documentation 
Some documentation was missing in net_mgmt.h header file.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
03e4716830 net: doc: net_ip.h: Improve documention 
Add doxygen documentation and hide internal documentation from
generated documents.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
3f24da5761 net: doc: net_if.h: Improve documentation 
Add missing doxygen comments.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
f1d1603eda net: doc: net_event.h: Document network events 
Add documentation to events that are triggered by the network stack.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
06abfee94b net: doc: net_context.h: Improve documentation 
Some doxygen comments were missing.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
8825075438 net: doc: mqtt_sn.h: Reshuffle doxygen comment 
Moving doxygen comment to proper place.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
aa59ac9de1 net: doc: mqtt.h: Improve documentation 
Some doxygen comments were missing.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
b711f5ac94 net: doc: mii.h: Add missing doxygen comments 
Some defines were missing doxygen comments.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
fe2bc1703d net: doc: mdio.h: Add missing doxygen comments 
Some defines were missing proper doxygen comment.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
1366371442 net: doc: lwm2m_path.h: Add missing @file specifier 
This will improve document coverage.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
055665238d net: doc: lwm2m.h: Improve documentation 
Add missing doxygen comments.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
a28949b451 net: doc: ipv4_autoconf.h: Improve documentaion 
Add missing doxygen comments to improve documentation coverage.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
4d46300be4 net: doc: igmp.h: Improve IGMP documentation 
Adding doxygen comments to improve documentation coverage.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
f5ae486c0e net: doc: ieee802154_radio_openthread.h: Improve documentation 
Add missing doxygen comments.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
04d12cc699 net: doc: ieee802154_radio.h: Add more documentation 
Added more doxygen comments to ieee802154 radio header file in
order to improve documentation coverage percentage.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
b3bbc8f763 net: doc: ieee802154_mgmt.h: Improve documentation coverage 
Add missing doxygen documentation markers to improve documentation
coverage percentage.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
78aaaba2cd net: doc: ieee802154_ie.h: Add more info to documentation 
This improves documentation coverage numbers for this file.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
effb78d03a net: doc: ieee802154.h: Improve documentation 
Add missing doxygen comments.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
8eb91fa11e net: doc: icmp.h: Add ICMPv4/6 packet type documentation 
Descriptions of both the ICMPv4 and v6 packet types were missing.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
3a555048f4 net: doc: http/service.h: Improve documentation 
Add missing doxygen comments.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
5b7b378dfe net: doc: http/server.h: Improve documentation 
Add missing doxygen comments.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
5119235a00 net: doc: http/method.h: Hide internal documentation 
Do not generate documentation for internal symbols.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
639fa20d08 net: doc: http/hpack.h: Hide internal documentation 
Prevent internal symbols from being in generated documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
b0fa414039 net: doc: http/frame.h: Improve documentation 
Doxygen documentation was totally missing in this file.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
de2cdd538b net: doc: http/client.h: Improve documentation 
Add missing doxygen comments.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
d206c5931a net: doc: hostname.h: Document hostname length macro properly 
Max hostname length was not documented.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
fb4dda2605 net: doc: gptp.h: Documentation missing for structs 
Add more struct documentation to gptp.h

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
9ec0f6ec4f net: doc: ethernet_bridge.h: Hide internal structs from doxygen 
Mark internal structs as hidden to avoid generating public
documentation for it.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
f1852b4a1d net: doc: ethernet.h: Document header file properly 
Documentation to various public features was missing.
Also some of the public features were marked in hidden section.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
ce3512bfaf net: doc: dummy.h: Document dummy L2 header file 
The dummy L2 header file was missing documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
ee26be4113 net: doc: dsa.h: Hide internal documentation 
Do not generate documentation for internal symbols.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
86537ca469 net: doc: dns_resolve.h: Improve documentation 
Couple of doxygen comments were missing.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
03e9b3f320 net: doc: dhcpv4.h: Document DHCPv4 message types 
The DHCPv4 message type documentation was missing.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00
Jukka Rissanen
bacff7fd28 net: doc: conn_mgr_monitor.h: Add @file documentation 
This improves documentation coverage metric for this file.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
 2024-05-21 15:41:19 -07:00