Skip to content

Commit adb558b

Browse files
committed
Fix some documentation mistakes
1 parent 42524de commit adb558b

4 files changed

Lines changed: 8 additions & 12 deletions

File tree

WebUntisAPI.Client/Models/ForeBackColors.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
namespace WebUntisAPI.Client.Models
66
{
77
/// <summary>
8-
/// Fore- and background color fore something
8+
/// Fore- and background color for something
99
/// </summary>
1010
public struct ForeBackColors
1111
{

WebUntisAPI.Client/Models/StatusData.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class StatusData
2121
public ForeBackColors OhColors { get; set; }
2222

2323
/// <summary>
24-
/// Colors for a standby
24+
/// Colors for a standby hour
2525
/// </summary>
2626
public ForeBackColors SbColors { get; set; }
2727

@@ -31,7 +31,7 @@ public class StatusData
3131
public ForeBackColors BsColors { get; set; }
3232

3333
/// <summary>
34-
/// Colors for a examination
34+
/// Colors for a examination hour
3535
/// </summary>
3636
public ForeBackColors ExColors { get; set; }
3737

WebUntisAPI.Client/SchoolSearch.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ public static class SchoolSearch
2323
/// <summary>
2424
/// Search for schools by the given name
2525
/// </summary>
26+
///
2627
/// <param name="name">Name to search</param>
2728
/// <param name="ct">Token to cancel the search request</param>
28-
/// <param name="id">Name to identifies the request</param>
29+
/// <param name="id">Identifier for the request</param>
2930
/// <returns>All schools found, an empty array when no school found or <see langword="null"/> when too many schools found</returns>
3031
/// <exception cref="WebUntisException">Throws when the WebUntis API returned an error</exception>
3132
/// <exception cref="HttpRequestException">Throws when an error happend while request</exception>

WebUntisAPI.Client/WebUntisClient.cs

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,7 @@ namespace WebUntisAPI.Client
1616
/// A client that connect to WebUntis server to load data
1717
/// </summary>
1818
/// <remarks>
19-
/// <para>
20-
/// Please use this class in a using declaration. When you dont use it in a using declaration please call <see cref="LogoutAsync(string, CancellationToken)"/> and <see cref="Dispose()"/> when you don't need the connection.
21-
/// </para>
22-
/// <para>
23-
/// Under no circumstances should 10 req. per sec., more than 1800req. per hr (but in no case more than 3600 req. per hr). If the specifications are exceeded, access to WebUntis is permanently blocked by the WebUntis API.
24-
/// </para>
19+
/// Under no circumstances should 10 req. per sec., more than 1800req. per hr (but in no case more than 3600 req. per hr). If the specifications are exceeded, access to WebUntis could permanently blocked by the WebUntis API.
2520
/// </remarks>
2621
public partial class WebUntisClient : IDisposable
2722
{
@@ -68,7 +63,7 @@ public partial class WebUntisClient : IDisposable
6863
/// </summary>
6964
/// <param name="clientName">Unique identifier for the client app</param>
7065
/// <param name="timeout">The time in milliseconds until requests will be timeouted</param>
71-
public WebUntisClient(string clientName, int timeout = 500)
66+
public WebUntisClient(string clientName, int timeout = 1000)
7267
{
7368
ClientName = clientName;
7469
Timeout = timeout;
@@ -127,7 +122,7 @@ public async Task<bool> LoginAsync(string server, string loginName, string usern
127122
// Setup server url
128123
Match serverName = Regex.Match(server, @"\w+\.webuntis\.com");
129124
if (!serverName.Success)
130-
throw new ArgumentException("This isn't a WebUntis server", nameof(server));
125+
throw new ArgumentException("This isn't a valid WebUntis server address", nameof(server));
131126
string serverUrl = "https://" + serverName.Value;
132127

133128
// Make request for login

0 commit comments

Comments
 (0)