David Smart / NTPClient

NTP Client for the mbed networking libraries. The small change to this version is that there can be only one cause for the return value zero.

Dependents:   WattEye

Fork of NTPClient by Donatien Garnier

Files at this revision

API Documentation at this revision

Revision 6:bef14adc58c4, committed 2014-10-11

Comitter:
WiredHome
Date:
Sat Oct 11 17:26:43 2014 +0000
Parent:
5:7ad0af977056
Child:
7:170915215fd4
Commit message:
Documentation updates only.

Changed in this revision

NTPClient.h Show annotated file Show diff for this revision Revisions of this file 
--- a/NTPClient.h	Sun Jun 22 20:54:44 2014 +0000
+++ b/NTPClient.h	Sat Oct 11 17:26:43 2014 +0000
@@ -59,9 +59,9 @@
   /**Get current time (blocking)
   Update the time using the server host
   Blocks until completion
-  @param host NTP server IPv4 address or hostname (will be resolved via DNS)
-  @param port port to use; defaults to 123
-  @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
+  @param[in] host NTP server IPv4 address or hostname (will be resolved via DNS)
+  @param[in] port port to use; defaults to 123
+  @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
   @return 0 on success, NTP error code (<0) on failure
   */
   NTPResult setTime(const char* host, uint16_t port = NTP_DEFAULT_PORT, uint32_t timeout = NTP_DEFAULT_TIMEOUT); //Blocking