Skip to content

Commit 729a38b

Browse files
committed
Doxygen for 73e76fe
1 parent 4c53b31 commit 729a38b

File tree

5 files changed

+168
-169
lines changed

5 files changed

+168
-169
lines changed

main/code_example.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -387,18 +387,18 @@
387387
<div class="ttc" id="agroup__sntp__enum__types_html_gaef7b22d8008bbfbbc7bbea5a7a30e798"><div class="ttname"><a href="group__sntp__enum__types.html#gaef7b22d8008bbfbbc7bbea5a7a30e798">SntpStatus_t</a></div><div class="ttdeci">SntpStatus_t</div><div class="ttdoc">Enumeration of status codes that can be returned by the coreSNTP Library API.</div><div class="ttdef"><b>Definition:</b> core_sntp_serializer.h:140</div></div>
388388
<div class="ttc" id="agroup__sntp__enum__types_html_ggaef7b22d8008bbfbbc7bbea5a7a30e798a473ea25a626b0ab1067a9887e49d113e"><div class="ttname"><a href="group__sntp__enum__types.html#ggaef7b22d8008bbfbbc7bbea5a7a30e798a473ea25a626b0ab1067a9887e49d113e">SntpNoResponseReceived</a></div><div class="ttdeci">@ SntpNoResponseReceived</div><div class="ttdoc">No SNTP packet for server response is received from the network by the Sntp_ReceiveTimeResponse API.</div><div class="ttdef"><b>Definition:</b> core_sntp_serializer.h:242</div></div>
389389
<div class="ttc" id="agroup__sntp__enum__types_html_ggaef7b22d8008bbfbbc7bbea5a7a30e798a8486f9ee1815b43418a9c0478bd8f016"><div class="ttname"><a href="group__sntp__enum__types.html#ggaef7b22d8008bbfbbc7bbea5a7a30e798a8486f9ee1815b43418a9c0478bd8f016">SntpSuccess</a></div><div class="ttdeci">@ SntpSuccess</div><div class="ttdoc">Successful operation of an SNTP API.</div><div class="ttdef"><b>Definition:</b> core_sntp_serializer.h:144</div></div>
390-
<div class="ttc" id="agroup__sntp__struct__types_html_ga7769e434e7811caed8cd6fd7f9ec26ec"><div class="ttname"><a href="group__sntp__struct__types.html#ga7769e434e7811caed8cd6fd7f9ec26ec">NetworkContext_t</a></div><div class="ttdeci">struct NetworkContext NetworkContext_t</div><div class="ttdoc">A user-defined type for context that is passed to the transport interface functions....</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:151</div></div>
391-
<div class="ttc" id="astruct_sntp_context__t_html"><div class="ttname"><a href="struct_sntp_context__t.html">SntpContext_t</a></div><div class="ttdoc">Structure for a context that stores state for managing a long-running SNTP client that periodically p...</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:372</div></div>
390+
<div class="ttc" id="agroup__sntp__struct__types_html_ga7769e434e7811caed8cd6fd7f9ec26ec"><div class="ttname"><a href="group__sntp__struct__types.html#ga7769e434e7811caed8cd6fd7f9ec26ec">NetworkContext_t</a></div><div class="ttdeci">struct NetworkContext NetworkContext_t</div><div class="ttdoc">A user-defined type for context that is passed to the transport interface functions....</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:148</div></div>
391+
<div class="ttc" id="astruct_sntp_context__t_html"><div class="ttname"><a href="struct_sntp_context__t.html">SntpContext_t</a></div><div class="ttdoc">Structure for a context that stores state for managing a long-running SNTP client that periodically p...</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:369</div></div>
392392
<div class="ttc" id="astruct_sntp_server_info__t_html"><div class="ttname"><a href="struct_sntp_server_info__t.html">SntpServerInfo_t</a></div><div class="ttdoc">Structure representing information for a time server.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:68</div></div>
393393
<div class="ttc" id="astruct_sntp_server_info__t_html_a2c89b20c6fa40631a1d70000a39a3df5"><div class="ttname"><a href="struct_sntp_server_info__t.html#a2c89b20c6fa40631a1d70000a39a3df5">SntpServerInfo_t::port</a></div><div class="ttdeci">uint16_t port</div><div class="ttdoc">The UDP port supported by the server for SNTP/NTP communication.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:71</div></div>
394394
<div class="ttc" id="astruct_sntp_server_info__t_html_a3ac6b772408c867c83bc278aebbfe192"><div class="ttname"><a href="struct_sntp_server_info__t.html#a3ac6b772408c867c83bc278aebbfe192">SntpServerInfo_t::pServerName</a></div><div class="ttdeci">const char * pServerName</div><div class="ttdoc">The time server name.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:69</div></div>
395395
<div class="ttc" id="astruct_sntp_timestamp__t_html"><div class="ttname"><a href="struct_sntp_timestamp__t.html">SntpTimestamp_t</a></div><div class="ttdoc">Structure representing an SNTP timestamp.</div><div class="ttdef"><b>Definition:</b> core_sntp_serializer.h:284</div></div>
396396
<div class="ttc" id="astruct_sntp_timestamp__t_html_a31fd5b20451f4c23534322b4eaa8d29f"><div class="ttname"><a href="struct_sntp_timestamp__t.html#a31fd5b20451f4c23534322b4eaa8d29f">SntpTimestamp_t::fractions</a></div><div class="ttdeci">uint32_t fractions</div><div class="ttdoc">The fractions part of the SNTP timestamp with resolution of 2^(-32) ~ 232 picoseconds.</div><div class="ttdef"><b>Definition:</b> core_sntp_serializer.h:286</div></div>
397397
<div class="ttc" id="astruct_sntp_timestamp__t_html_a747c002d1a619beef24932a2703a579c"><div class="ttname"><a href="struct_sntp_timestamp__t.html#a747c002d1a619beef24932a2703a579c">SntpTimestamp_t::seconds</a></div><div class="ttdeci">uint32_t seconds</div><div class="ttdoc">Number of seconds since epoch time.</div><div class="ttdef"><b>Definition:</b> core_sntp_serializer.h:285</div></div>
398-
<div class="ttc" id="astruct_udp_transport_interface__t_html"><div class="ttname"><a href="struct_udp_transport_interface__t.html">UdpTransportInterface_t</a></div><div class="ttdoc">Struct representing the UDP transport interface for user-defined functions that coreSNTP library depe...</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:236</div></div>
399-
<div class="ttc" id="astruct_udp_transport_interface__t_html_a30f8e36e611f4d510d4ffa20b19d3cb4"><div class="ttname"><a href="struct_udp_transport_interface__t.html#a30f8e36e611f4d510d4ffa20b19d3cb4">UdpTransportInterface_t::recvFrom</a></div><div class="ttdeci">UdpTransportRecvFrom_t recvFrom</div><div class="ttdoc">The user-defined UDP receive function.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:240</div></div>
400-
<div class="ttc" id="astruct_udp_transport_interface__t_html_a332883a73a30ab9fb229ff24f305f0b5"><div class="ttname"><a href="struct_udp_transport_interface__t.html#a332883a73a30ab9fb229ff24f305f0b5">UdpTransportInterface_t::sendTo</a></div><div class="ttdeci">UdpTransportSendTo_t sendTo</div><div class="ttdoc">The user-defined UDP send function.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:239</div></div>
401-
<div class="ttc" id="astruct_udp_transport_interface__t_html_ad47cd85071e0815a75f749710096190e"><div class="ttname"><a href="struct_udp_transport_interface__t.html#ad47cd85071e0815a75f749710096190e">UdpTransportInterface_t::pUserContext</a></div><div class="ttdeci">NetworkContext_t * pUserContext</div><div class="ttdoc">The user-defined context for storing network socket information.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:237</div></div>
398+
<div class="ttc" id="astruct_udp_transport_interface__t_html"><div class="ttname"><a href="struct_udp_transport_interface__t.html">UdpTransportInterface_t</a></div><div class="ttdoc">Struct representing the UDP transport interface for user-defined functions that coreSNTP library depe...</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:233</div></div>
399+
<div class="ttc" id="astruct_udp_transport_interface__t_html_a30f8e36e611f4d510d4ffa20b19d3cb4"><div class="ttname"><a href="struct_udp_transport_interface__t.html#a30f8e36e611f4d510d4ffa20b19d3cb4">UdpTransportInterface_t::recvFrom</a></div><div class="ttdeci">UdpTransportRecvFrom_t recvFrom</div><div class="ttdoc">The user-defined UDP receive function.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:237</div></div>
400+
<div class="ttc" id="astruct_udp_transport_interface__t_html_a332883a73a30ab9fb229ff24f305f0b5"><div class="ttname"><a href="struct_udp_transport_interface__t.html#a332883a73a30ab9fb229ff24f305f0b5">UdpTransportInterface_t::sendTo</a></div><div class="ttdeci">UdpTransportSendTo_t sendTo</div><div class="ttdoc">The user-defined UDP send function.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:236</div></div>
401+
<div class="ttc" id="astruct_udp_transport_interface__t_html_ad47cd85071e0815a75f749710096190e"><div class="ttname"><a href="struct_udp_transport_interface__t.html#ad47cd85071e0815a75f749710096190e">UdpTransportInterface_t::pUserContext</a></div><div class="ttdeci">NetworkContext_t * pUserContext</div><div class="ttdoc">The user-defined context for storing network socket information.</div><div class="ttdef"><b>Definition:</b> core_sntp_client.h:234</div></div>
402402
</div><!-- fragment --> </div></div><!-- contents -->
403403
</div><!-- PageDoc -->
404404
</div><!-- doc-content -->

0 commit comments

Comments
 (0)