Add XML doc

Author: ethanhann

IntegrationEngine.Client/EndpointName.cs

@@ -2,12 +2,30 @@
 
 namespace IntegrationEngine.Client
 {
+    /// <summary>
+    /// Endpoint name.
+    /// </summary>
     public class EndpointName
     { 
+        /// <summary>
+        /// The cron trigger.
+        /// </summary>
         public static string CronTrigger = "CronTrigger";
+        /// <summary>
+        /// The simple trigger.
+        /// </summary>
         public static string SimpleTrigger = "SimpleTrigger";
+        /// <summary>
+        /// The type of the job.
+        /// </summary>
         public static string JobType = "JobType";
+        /// <summary>
+        /// The time zone.
+        /// </summary>
         public static string TimeZone = "TimeZone";
+        /// <summary>
+        /// The health status.
+        /// </summary>
         public static string HealthStatus = "HealthStatus";
     }
 }

IntegrationEngine.Client/InEngineClient.cs

@@ -9,26 +9,47 @@
 
 namespace IntegrationEngine.Client
 {
+    /// <summary>
+    /// In engine client.
+    /// </summary>
     public class InEngineClient : IInEngineClient
     {
+        /// <summary>
+        /// Gets or sets the rest client.
+        /// </summary>
+        /// <value>The rest client.</value>
         public RestClient RestClient { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="IntegrationEngine.Client.InEngineClient"/> class.
+        /// </summary>
         public InEngineClient() 
             : this("http://localhost:9001/api/")
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="IntegrationEngine.Client.InEngineClient"/> class.
+        /// </summary>
+        /// <param name="apiUrl">API URL.</param>
         public InEngineClient(string apiUrl)
         {
             RestClient = new RestClient(apiUrl);
         }
 
+        /// <summary>
+        /// Ping the server.
+        /// </summary>
         public HttpStatusCode Ping()
         {
             return RestClient.Execute(new RestRequest(EndpointName.HealthStatus, Method.GET)).StatusCode;
         }
 
         #region CronTrigger
+        /// <summary>
+        /// Gets the cron triggers.
+        /// </summary>
+        /// <returns>The cron triggers.</returns>
         public IList<CronTrigger> GetCronTriggers()
         {
             var request = new RestRequest(EndpointName.CronTrigger, Method.GET);
@@ -37,6 +58,11 @@ public IList<CronTrigger> GetCronTriggers()
             return JsonConvert.DeserializeObject<IList<CronTrigger>>(result.Content);
         }
 
+        /// <summary>
+        /// Gets the cron trigger by identifier.
+        /// </summary>
+        /// <returns>The cron trigger by identifier.</returns>
+        /// <param name="id">Identifier.</param>
         public CronTrigger GetCronTriggerById(string id)
         {
             var request = new RestRequest(EndpointName.CronTrigger + "/{id}", Method.GET);
@@ -45,6 +71,11 @@ public CronTrigger GetCronTriggerById(string id)
             return JsonConvert.DeserializeObject<CronTrigger>(result.Content);
         }
 
+        /// <summary>
+        /// Creates the cron trigger.
+        /// </summary>
+        /// <returns>The cron trigger.</returns>
+        /// <param name="cronTrigger">Cron trigger.</param>
         public CronTrigger CreateCronTrigger(CronTrigger cronTrigger)
         {
             var request = new RestRequest(EndpointName.CronTrigger, Method.POST);
@@ -53,6 +84,11 @@ public CronTrigger CreateCronTrigger(CronTrigger cronTrigger)
             return JsonConvert.DeserializeObject<CronTrigger>(result.Content);
         }
 
+        /// <summary>
+        /// Updates the cron trigger.
+        /// </summary>
+        /// <returns>The cron trigger.</returns>
+        /// <param name="cronTrigger">Cron trigger.</param>
         public CronTrigger UpdateCronTrigger(CronTrigger cronTrigger)
         {
             var request = new RestRequest(EndpointName.CronTrigger + "/{id}", Method.PUT);
@@ -62,6 +98,11 @@ public CronTrigger UpdateCronTrigger(CronTrigger cronTrigger)
             return JsonConvert.DeserializeObject<CronTrigger>(result.Content);
         }
 
+        /// <summary>
+        /// Deletes the cron trigger.
+        /// </summary>
+        /// <returns>The cron trigger.</returns>
+        /// <param name="id">Identifier.</param>
         public CronTrigger DeleteCronTrigger(string id)
         {
             var request = new RestRequest(EndpointName.CronTrigger + "/{id}", Method.DELETE);
@@ -72,13 +113,22 @@ public CronTrigger DeleteCronTrigger(string id)
         #endregion
 
         #region SimpleTrigger
+        /// <summary>
+        /// Gets the simple triggers.
+        /// </summary>
+        /// <returns>The simple triggers.</returns>
         public IList<SimpleTrigger> GetSimpleTriggers()
         {
             var request = new RestRequest(EndpointName.SimpleTrigger, Method.GET);
             var result = RestClient.Execute(request);
             return JsonConvert.DeserializeObject<IList<SimpleTrigger>>(result.Content);
         }
 
+        /// <summary>
+        /// Gets the simple trigger by identifier.
+        /// </summary>
+        /// <returns>The simple trigger by identifier.</returns>
+        /// <param name="id">Identifier.</param>
         public SimpleTrigger GetSimpleTriggerById(string id)
         {
             var request = new RestRequest(EndpointName.SimpleTrigger + "/{id}", Method.GET);
@@ -87,6 +137,11 @@ public SimpleTrigger GetSimpleTriggerById(string id)
             return JsonConvert.DeserializeObject<SimpleTrigger>(result.Content);
         }
 
+        /// <summary>
+        /// Creates the simple trigger.
+        /// </summary>
+        /// <returns>The simple trigger.</returns>
+        /// <param name="simpleTrigger">Simple trigger.</param>
         public SimpleTrigger CreateSimpleTrigger(SimpleTrigger simpleTrigger)
         {
             var request = new RestRequest(EndpointName.SimpleTrigger, Method.POST);
@@ -95,6 +150,12 @@ public SimpleTrigger CreateSimpleTrigger(SimpleTrigger simpleTrigger)
             return JsonConvert.DeserializeObject<SimpleTrigger>(result.Content);
         }
 
+
+        /// <summary>
+        /// Updates the simple trigger.
+        /// </summary>
+        /// <returns>The simple trigger.</returns>
+        /// <param name="simpleTrigger">Simple trigger.</param>
         public SimpleTrigger UpdateSimpleTrigger(SimpleTrigger simpleTrigger)
         {
             var request = new RestRequest(EndpointName.SimpleTrigger + "/{id}", Method.PUT);
@@ -104,6 +165,11 @@ public SimpleTrigger UpdateSimpleTrigger(SimpleTrigger simpleTrigger)
             return JsonConvert.DeserializeObject<SimpleTrigger>(result.Content);
         }
 
+        /// <summary>
+        /// Deletes the simple trigger.
+        /// </summary>
+        /// <returns>The simple trigger.</returns>
+        /// <param name="id">Identifier.</param>
         public SimpleTrigger DeleteSimpleTrigger(string id)
         {
             var request = new RestRequest(EndpointName.SimpleTrigger + "/{id}", Method.DELETE);
@@ -114,6 +180,10 @@ public SimpleTrigger DeleteSimpleTrigger(string id)
         #endregion
 
         #region TimeZone
+        /// <summary>
+        /// Gets the time zones.
+        /// </summary>
+        /// <returns>The time zones.</returns>
         public IList<InEngineTimeZone> GetTimeZones()
         {
             var request = new RestRequest(EndpointName.TimeZone, Method.GET);
@@ -123,6 +193,10 @@ public IList<InEngineTimeZone> GetTimeZones()
         #endregion
 
         #region JobType
+        /// <summary>
+        /// Gets the job types.
+        /// </summary>
+        /// <returns>The job types.</returns>
         public IList<JobType> GetJobTypes()
         {
             var request = new RestRequest(EndpointName.JobType, Method.GET);
@@ -132,6 +206,10 @@ public IList<JobType> GetJobTypes()
         #endregion
 
         #region HealthStatus
+        /// <summary>
+        /// Gets the health status.
+        /// </summary>
+        /// <returns>The health status.</returns>
         public HealthStatus GetHealthStatus()
         {
             var request = new RestRequest(EndpointName.HealthStatus, Method.GET);

IntegrationEngine.Client/IntegrationEngine.Client.csproj

@@ -20,6 +20,7 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <ConsolePause>false</ConsolePause>
+    <DocumentationFile>bin\Debug\InEngine.NET.Client.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>full</DebugType>