Skip to content

Commit fb3fe6a

Browse files
committed
chore: documentation method to avoid github warnings
1 parent 9a25bc3 commit fb3fe6a

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

Functions/InvokeFunctionOptions.cs

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,38 +50,83 @@ public class FunctionRegion : IEquatable<FunctionRegion>
5050
{
5151
private string _region;
5252

53+
/// <summary>
54+
/// Empty region
55+
/// </summary>
5356
public static FunctionRegion Any { get; } = new FunctionRegion("any");
5457

58+
/// <summary>
59+
/// Represents the region "ap-northeast-1" for function requests.
60+
/// </summary>
5561
public static FunctionRegion ApNortheast1 { get; } =
5662
new FunctionRegion("ap-northeast-1");
5763

64+
/// <summary>
65+
/// Represents the "ap-northeast-2" region for function invocation.
66+
/// </summary>
5867
public static FunctionRegion ApNortheast2 { get; } =
5968
new FunctionRegion("ap-northeast-2");
6069

70+
/// <summary>
71+
/// Represents the "ap-south-1" region used for requests.
72+
/// </summary>
6173
public static FunctionRegion ApSouth1 { get; } = new FunctionRegion("ap-south-1");
6274

75+
/// <summary>
76+
/// Represents the region "ap-southeast-1" for function invocation.
77+
/// </summary>
6378
public static FunctionRegion ApSoutheast1 { get; } =
6479
new FunctionRegion("ap-southeast-1");
6580

81+
/// <summary>
82+
/// Represents the "ap-southeast-2" region for requests.
83+
/// </summary>
6684
public static FunctionRegion ApSoutheast2 { get; } =
6785
new FunctionRegion("ap-southeast-2");
6886

87+
/// <summary>
88+
/// Represents the Canada (Central) region for requests.
89+
/// </summary>
6990
public static FunctionRegion CaCentral1 { get; } = new FunctionRegion("ca-central-1");
7091

92+
/// <summary>
93+
/// Represents the "eu-central-1" region for function invocation.
94+
/// </summary>
7195
public static FunctionRegion EuCentral1 { get; } = new FunctionRegion("eu-central-1");
7296

97+
/// <summary>
98+
/// Represents the "eu-west-1" function region for requests.
99+
/// </summary>
73100
public static FunctionRegion EuWest1 { get; } = new FunctionRegion("eu-west-1");
74101

102+
/// <summary>
103+
/// Represents the "eu-west-2" region for function invocation requests.
104+
/// </summary>
75105
public static FunctionRegion EuWest2 { get; } = new FunctionRegion("eu-west-2");
76106

107+
/// <summary>
108+
/// Represents the AWS region 'eu-west-3'.
109+
/// </summary>
77110
public static FunctionRegion EuWest3 { get; } = new FunctionRegion("eu-west-3");
78111

112+
/// <summary>
113+
/// Represents the South America (São Paulo) region for requests.
114+
/// </summary>
79115
public static FunctionRegion SaEast1 { get; } = new FunctionRegion("sa-east-1");
80116

117+
/// <summary>
118+
/// Represents the "us-east-1" region for function requests.
119+
/// </summary>
81120
public static FunctionRegion UsEast1 { get; } = new FunctionRegion("us-east-1");
82121

122+
/// <summary>
123+
/// Represents the us-west-1 region for function requests.
124+
/// </summary>
83125
public static FunctionRegion UsWest1 { get; } = new FunctionRegion("us-west-1");
84126

127+
/// <summary>
128+
/// Represents the "us-west-2" region for requests.
129+
/// </summary>
85130
public static FunctionRegion UsWest2 { get; } = new FunctionRegion("us-west-2");
86131

87132
/// <summary>
@@ -128,8 +173,14 @@ public bool Equals(FunctionRegion other)
128173
public static bool operator !=(FunctionRegion left, FunctionRegion right) =>
129174
!Equals(left, right);
130175

176+
/// <summary>
177+
/// Overloads the explicit cast operator to convert a FunctionRegion object to a string.
178+
/// </summary>
131179
public static explicit operator string(FunctionRegion region) => region.ToString();
132180

181+
/// <summary>
182+
/// Overloads the explicit cast operator to convert a string to a FunctionRegion object.
183+
/// </summary>
133184
public static explicit operator FunctionRegion(string region) =>
134185
new FunctionRegion(region);
135186

0 commit comments

Comments
 (0)