Skip to content

Commit 436b0f7

Browse files
committed
Ran code cleanup to automatically add missing documentation
1 parent 98a2bae commit 436b0f7

38 files changed

+935
-891
lines changed

README.md

-3
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,6 @@ Asychronous:
7272

7373
#### Building the source
7474

75-
The source can be built from the rake task `rake build` or using visual studio. If using rake, ensure `albacore`
76-
and `version_bumper` gems are installed. Rename `rakefile.config.example.rb` to `rakefile.config.rb`.
77-
7875
For running tests, ensure to rename `AppSettings.example.config` to `AppSettings.config` and
7976
set your own Api Key in the test project. Tests can be executed from rake: `rake test` or from any nunit test runner
8077
tool.

src/Mandrill/Configuration.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@
1010
namespace Mandrill
1111
{
1212
/// <summary>
13-
/// The configuration.
13+
/// The configuration.
1414
/// </summary>
1515
internal static class Configuration
1616
{
1717
#region Static Fields
1818

1919
/// <summary>
20-
/// The bas e_ secur e_ url.
20+
/// The bas e_ secur e_ url.
2121
/// </summary>
2222
public static string BASE_SECURE_URL = "https://mandrillapp.com/api/1.0/";
2323

2424
/// <summary>
25-
/// The bas e_ url.
25+
/// The bas e_ url.
2626
/// </summary>
2727
public static string BASE_URL = "http://mandrillapp.com/api/1.0/";
2828

2929
/// <summary>
30-
/// The dat e_ tim e_ forma t_ string.
30+
/// The dat e_ tim e_ forma t_ string.
3131
/// </summary>
3232
public static string DATE_TIME_FORMAT_STRING = "yyyy-MM-dd HH:mm:ss";
3333

src/Mandrill/MandrillApi.cs

+23-25
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ public partial class MandrillApi
3434
#region Constructors and Destructors
3535

3636
/// <summary>
37-
/// Initializes a new instance of the <see cref="MandrillApi"/> class.
37+
/// Initializes a new instance of the <see cref="MandrillApi" /> class.
3838
/// </summary>
3939
/// <param name="apiKey">
40-
/// The API Key recieved from MandrillApp
40+
/// The API Key recieved from MandrillApp
4141
/// </param>
4242
/// <param name="useSsl">
4343
/// </param>
4444
/// <param name="timeout">
45-
/// Timeout in milliseconds to use for requests.
45+
/// Timeout in milliseconds to use for requests.
4646
/// </param>
4747
public MandrillApi(string apiKey, bool useSsl = true, int timeout = 0)
4848
{
@@ -70,35 +70,32 @@ public MandrillApi(string apiKey, bool useSsl = true, int timeout = 0)
7070
/// </summary>
7171
public string ApiKey { get; private set; }
7272

73-
/// <summary>
74-
/// UserAgent to use for requests.
75-
/// </summary>
76-
public string UserAgent
73+
public IWebProxy Proxy
7774
{
7875
get
7976
{
80-
return client.UserAgent;
77+
return this.client.Proxy;
8178
}
8279
set
8380
{
84-
client.UserAgent = value;
81+
this.client.Proxy = value;
8582
}
8683
}
87-
88-
public System.Net.IWebProxy Proxy
89-
{
84+
85+
/// <summary>
86+
/// UserAgent to use for requests.
87+
/// </summary>
88+
public string UserAgent
89+
{
9090
get
9191
{
92-
return client.Proxy;
92+
return this.client.UserAgent;
9393
}
9494
set
9595
{
96-
client.Proxy = value;
96+
this.client.UserAgent = value;
9797
}
9898
}
99-
100-
101-
10299

103100
#endregion
104101

@@ -134,17 +131,18 @@ public System.Net.IWebProxy Proxy
134131

135132
// return tcs.Task;
136133
// }
134+
137135
#region Public Methods and Operators
138136

139137
/// <summary>
140-
/// PostAsync (uses synchronous function right now because ExecuteAsync has a bug)
138+
/// PostAsync (uses synchronous function right now because ExecuteAsync has a bug)
141139
/// </summary>
142140
/// <param name="path">
143141
/// </param>
144142
/// <param name="data">
145143
/// </param>
146144
/// <returns>
147-
/// The <see cref="Task"/>.
145+
/// The <see cref="Task" />.
148146
/// </returns>
149147
public Task<IRestResponse> PostAsync(string path, dynamic data)
150148
{
@@ -184,18 +182,18 @@ public Task<IRestResponse> PostAsync(string path, dynamic data)
184182
}
185183

186184
/// <summary>
187-
/// The post async.
185+
/// The post async.
188186
/// </summary>
189187
/// <param name="path">
190-
/// The path.
188+
/// The path.
191189
/// </param>
192190
/// <param name="data">
193-
/// The data.
191+
/// The data.
194192
/// </param>
195193
/// <typeparam name="T">
196194
/// </typeparam>
197195
/// <returns>
198-
/// The <see cref="Task"/>.
196+
/// The <see cref="Task" />.
199197
/// </returns>
200198
public Task<T> PostAsync<T>(string path, dynamic data) where T : new()
201199
{
@@ -206,10 +204,10 @@ public Task<IRestResponse> PostAsync(string path, dynamic data)
206204
{
207205
var t = JSON.Parse<T>(p.Result.Content);
208206
return t;
209-
},
207+
},
210208
TaskContinuationOptions.ExecuteSynchronously);
211209
}
212210

213211
#endregion
214212
}
215-
}
213+
}

0 commit comments

Comments
 (0)