Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added missing xml comments for RouteDescription

  • Loading branch information...
commit 02d317a657063cb9bacd15e29ceca5a1ffc127c5 1 parent 53489f0
@thecodejunkie thecodejunkie authored
Showing with 21 additions and 0 deletions.
  1. +21 −0 src/Nancy/Routing/RouteDescription.cs
View
21 src/Nancy/Routing/RouteDescription.cs
@@ -2,8 +2,17 @@ namespace Nancy.Routing
{
using System;
+ /// <summary>
+ /// Represents the various parts of a route lambda.
+ /// </summary>
public sealed class RouteDescription
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="RouteDescription"/> class.
+ /// </summary>
+ /// <param name="method">The request method of the route.</param>
+ /// <param name="path">The path that the route will be invoked for.</param>
+ /// <param name="condition">The condition that has to be fulfilled for the route to be a valid match.</param>
public RouteDescription(string method, string path, Func<NancyContext, bool> condition)
{
if (String.IsNullOrEmpty(method))
@@ -21,10 +30,22 @@ public RouteDescription(string method, string path, Func<NancyContext, bool> con
this.Condition = condition;
}
+ /// <summary>
+ /// The condition that has to be fulfilled inorder for the route to be a valid match.
+ /// </summary>
+ /// <value>A function that evaluates the condition when a <see cref="NancyContext"/> instance is passed in.</value>
public Func<NancyContext, bool> Condition { get; private set; }
+ /// <summary>
+ /// Gets the method of the route.
+ /// </summary>
+ /// <value>A <see cref="string"/> containing the method of the route.</value>
public string Method { get; private set; }
+ /// <summary>
+ /// Gets the path that the route will be invoked for.
+ /// </summary>
+ /// <value>A <see cref="string"/> containing the path of the route.</value>
public string Path { get; private set; }
}
}
Please sign in to comment.
Something went wrong with that request. Please try again.