Skip to content

Commit ef61e77

Browse files
Improve comments for Intellisense (#127)
***NO_CI***
1 parent fe77818 commit ef61e77

File tree

1 file changed

+23
-9
lines changed
  • nanoFramework.Networking.Sntp

1 file changed

+23
-9
lines changed

nanoFramework.Networking.Sntp/Sntp.cs

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,25 @@
88
namespace nanoFramework.Networking
99
{
1010
/// <summary>
11-
/// Provides a set of methods that help developers to manage the SNTP (Simple Network Time Protocol) client on the target device.
11+
/// Provides a set of methods that help manage the Simple Network Time Protocol (SNTP) client on the target device.
1212
/// </summary>
1313
/// <remarks>
14-
/// For a list of some public NTP servers, see this link :
15-
/// http://support.ntp.org/bin/view/Servers/NTPPoolServers
14+
/// This class is specific to .NET nanoFramework.
1615
/// </remarks>
1716
public class Sntp
1817
{
1918
/// <summary>
2019
/// Starts the SNTP client.
21-
/// After this method returns a periodic call to the set SNTP servers is performed providing time synchronization.
22-
/// The system time is updated immediately after each successful execution.
23-
/// The time synchronization occurs on a hourly rate.
20+
/// After this method returns, a periodic call to the set SNTP servers is performed providing time synchronization.
2421
/// </summary>
25-
/// <remarks>This method is specific to nanoFramework.</remarks>
22+
/// <remarks>
23+
/// <para>
24+
/// The system time is updated immediately after each successful execution.
25+
/// </para>
26+
/// <para>
27+
/// By default the time synchronization occurs on a hourly rate.
28+
/// </para>
29+
/// </remarks>
2630
[MethodImpl(MethodImplOptions.InternalCall)]
2731
public static extern void Start();
2832

@@ -52,8 +56,13 @@ public static extern bool IsStarted
5256
}
5357

5458
/// <summary>
55-
/// Gets, sets the address of the SNTP server 1.
59+
/// Gets or sets the host address of the main SNTP server.
60+
/// By default it uses the server '0.pool.ntp.org'.
5661
/// </summary>
62+
/// <remarks>
63+
/// For a list of some public NTP servers, see this link:
64+
/// http://support.ntp.org/bin/view/Servers/NTPPoolServers
65+
/// </remarks>
5766
public static extern string Server1
5867
{
5968
[MethodImpl(MethodImplOptions.InternalCall)]
@@ -64,8 +73,13 @@ public static extern string Server1
6473
}
6574

6675
/// <summary>
67-
/// Gets, sets the address of the SNTP server 2.
76+
/// Gets or sets the host address of the backup SNTP server.
77+
/// By default it uses the server '1.pool.ntp.org'.
6878
/// </summary>
79+
/// <remarks>
80+
/// For a list of some public NTP servers, see this link:
81+
/// http://support.ntp.org/bin/view/Servers/NTPPoolServers
82+
/// </remarks>
6983
public static extern string Server2
7084
{
7185
[MethodImpl(MethodImplOptions.InternalCall)]

0 commit comments

Comments
 (0)