File tree Expand file tree Collapse file tree 4 files changed +14
-7
lines changed Expand file tree Collapse file tree 4 files changed +14
-7
lines changed Original file line number Diff line number Diff line change @@ -15,7 +15,7 @@ namespace nanoFramework.WebServer
1515 public class Authentication
1616 {
1717 /// <summary>
18- /// The type of authentication
18+ /// The type of authentication.
1919 /// </summary>
2020 public AuthenticationType AuthenticationType { get ; internal set ; }
2121
@@ -25,7 +25,7 @@ public class Authentication
2525 public NetworkCredential Credentials { get ; internal set ; } = null ;
2626
2727 /// <summary>
28- /// The API Key
28+ /// The API Key to use for authentication.
2929 /// </summary>
3030 public string ApiKey { get ; internal set ; } = null ;
3131
Original file line number Diff line number Diff line change 99namespace nanoFramework . WebServer
1010{
1111 /// <summary>
12- /// The type of authentication to use
12+ /// The type of authentication to use.
1313 /// </summary>
1414 public enum AuthenticationType
1515 {
1616 /// <summary>
17- /// No authentication is needed
17+ /// No authentication is needed.
1818 /// </summary>
1919 None ,
2020
2121 /// <summary>
22- /// Basic authentication with user and password
22+ /// Basic authentication with user and password.
2323 /// </summary>
2424 Basic ,
2525
2626 /// <summary>
27- /// Using an ApiKey
27+ /// Using an ApiKey.
2828 /// </summary>
2929 ApiKey
3030 }
Original file line number Diff line number Diff line change @@ -10,6 +10,10 @@ namespace nanoFramework.WebServer
1010 /// <summary>
1111 /// The HTTP Method.
1212 /// </summary>
13+ /// <remarks>
14+ /// No validation is performed if the HTTP method is a valid one.
15+ /// For details on how to use, see: https://github.com/nanoframework/nanoFramework.WebServer#usage
16+ /// </remarks>
1317 [ AttributeUsage ( AttributeTargets . Method ) ]
1418 public class MethodAttribute : Attribute
1519 {
Original file line number Diff line number Diff line change @@ -10,6 +10,10 @@ namespace nanoFramework.WebServer
1010 /// <summary>
1111 /// Route custom attribute.
1212 /// </summary>
13+ /// <remarks>
14+ /// For example: test/any.
15+ /// For details on how to use, see: https://github.com/nanoframework/nanoFramework.WebServer#usage
16+ /// </remarks>
1317 [ AttributeUsage ( AttributeTargets . Method , AllowMultiple = true ) ]
1418 public class RouteAttribute : Attribute
1519 {
@@ -26,6 +30,5 @@ public RouteAttribute(string route)
2630 {
2731 Route = route ;
2832 }
29-
3033 }
3134}
You can’t perform that action at this time.
0 commit comments