doc: net: Add page for net_time

So that the type is visible and "referencable" in the documentation. Signed-off-by: Robert Lubos <[email protected]>
zephyrproject-rtos · Oct 10, 2023 · fdaba20 · fdaba20
1 parent ae109c6
commit fdaba20
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/doc/connectivity/networking/api/net_time.rst b/doc/connectivity/networking/api/net_time.rst
@@ -0,0 +1,9 @@
+.. _net_time_interface:
+
+Network time representation in the network stack
+################################################
+
+API Reference
+*************
+
+.. doxygengroup:: net_time
diff --git a/doc/connectivity/networking/api/tsn.rst b/doc/connectivity/networking/api/tsn.rst
@@ -7,4 +7,5 @@ Time Sensitive Networking
    :maxdepth: 1
 
    gptp.rst
+   net_time.rst
    ptp_time.rst
diff --git a/include/zephyr/net/net_time.h b/include/zephyr/net/net_time.h
@@ -12,6 +12,10 @@
  * Inspired by
  * https://github.com/torvalds/linux/blob/master/include/linux/ktime.h and
  * https://github.com/torvalds/linux/blob/master/[tools/]include/linux/time64.h
+ *
+ * @defgroup net_time Network time representation.
+ * @ingroup networking
+ * @{
  */
 
 #ifndef ZEPHYR_INCLUDE_NET_NET_TIME_H_
@@ -112,4 +116,8 @@ typedef int64_t net_time_t;
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* ZEPHYR_INCLUDE_NET_NET_TIME_H_ */