Skip to content

Commit e2e9f84

Browse files
author
Vlad Cananau
committed
More code comments
1 parent 0f708c9 commit e2e9f84

11 files changed

+91
-10
lines changed

src/ResourceManager/Dns/Commands.Dns/Models/DnsRecordSet.cs

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ public class DnsRecordSet
6767
public Hashtable[] Tags { get; set; }
6868
}
6969

70+
/// <summary>
71+
/// Represents a DNS record that is part of a <see cref="DnsRecordSet"/>.
72+
/// </summary>
7073
public abstract class DnsRecordBase
7174
{
7275
internal abstract object ToMamlRecord();
@@ -152,8 +155,14 @@ internal static DnsRecordBase FromMamlRecord(object record)
152155
}
153156
}
154157

158+
/// <summary>
159+
/// Represents a DNS record of type A that is part of a <see cref="DnsRecordSet"/>.
160+
/// </summary>
155161
public class ARecord : DnsRecordBase
156162
{
163+
/// <summary>
164+
/// Gets or sets the IPv4 address of this A record in string notation
165+
/// </summary>
157166
public string Ipv4Address { get; set; }
158167

159168
public override string ToString()
@@ -170,8 +179,14 @@ internal override object ToMamlRecord()
170179
}
171180
}
172181

182+
/// <summary>
183+
/// Represents a DNS record of type AAAA that is part of a <see cref="DnsRecordSet"/>.
184+
/// </summary>
173185
public class AaaaRecord : DnsRecordBase
174186
{
187+
/// <summary>
188+
/// Gets or sets the IPv6 address of this AAAA record in string notation.
189+
/// </summary>
175190
public string Ipv6Address { get; set; }
176191

177192
public override string ToString()
@@ -188,8 +203,14 @@ internal override object ToMamlRecord()
188203
}
189204
}
190205

206+
/// <summary>
207+
/// Represents a DNS record of type CNAME that is part of a <see cref="DnsRecordSet"/>.
208+
/// </summary>
191209
public class CnameRecord : DnsRecordBase
192210
{
211+
/// <summary>
212+
/// Gets or sets the canonical name for this CNAME record without a terminating dot.
213+
/// </summary>
193214
public string Cname { get; set; }
194215

195216
public override string ToString()
@@ -206,8 +227,14 @@ internal override object ToMamlRecord()
206227
}
207228
}
208229

230+
/// <summary>
231+
/// Represents a DNS record of type NS that is part of a <see cref="DnsRecordSet"/>.
232+
/// </summary>
209233
public class NsRecord : DnsRecordBase
210234
{
235+
/// <summary>
236+
/// Gets or sets the name server name for this NS record, without a terminating dot.
237+
/// </summary>
211238
public string Nsdname { get; set; }
212239

213240
public override string ToString()
@@ -224,8 +251,14 @@ internal override object ToMamlRecord()
224251
}
225252
}
226253

254+
/// <summary>
255+
/// Represents a DNS record of type TXT that is part of a <see cref="DnsRecordSet"/>.
256+
/// </summary>
227257
public class TxtRecord : DnsRecordBase
228258
{
259+
/// <summary>
260+
/// Gets or sets the text value of this TXT record.
261+
/// </summary>
229262
public string Value { get; set; }
230263

231264
public override string ToString()
@@ -242,10 +275,19 @@ internal override object ToMamlRecord()
242275
}
243276
}
244277

278+
/// <summary>
279+
/// Represents a DNS record of type MX that is part of a <see cref="DnsRecordSet"/>.
280+
/// </summary>
245281
public class MxRecord : DnsRecordBase
246282
{
283+
/// <summary>
284+
/// Gets or sets the preference metric for this MX record.
285+
/// </summary>
247286
public ushort Preference { get; set; }
248287

288+
/// <summary>
289+
/// Gets or sets the domain name of the mail host, without a terminating dot
290+
/// </summary>
249291
public string Exchange { get; set; }
250292

251293
public override string ToString()
@@ -263,14 +305,29 @@ internal override object ToMamlRecord()
263305
}
264306
}
265307

308+
/// <summary>
309+
/// Represents a DNS record of type SRV that is part of a <see cref="DnsRecordSet"/>.
310+
/// </summary>
266311
public class SrvRecord : DnsRecordBase
267312
{
313+
/// <summary>
314+
/// Gets or sets the domain name of the target for this SRV record, without a terminating dot.
315+
/// </summary>
268316
public string Target { get; set; }
269317

318+
/// <summary>
319+
/// Gets or sets the weight metric for this SRV record.
320+
/// </summary>
270321
public ushort Weight { get; set; }
271322

323+
/// <summary>
324+
/// Gets or sets the port for this SRV record
325+
/// </summary>
272326
public ushort Port { get; set; }
273327

328+
/// <summary>
329+
/// Gets or sets the priority metric for this SRV record.
330+
/// </summary>
274331
public ushort Priority { get; set; }
275332

276333
public override string ToString()
@@ -290,20 +347,44 @@ internal override object ToMamlRecord()
290347
}
291348
}
292349

350+
/// <summary>
351+
/// Represents a DNS record of type SOA that is part of a <see cref="DnsRecordSet"/>.
352+
/// </summary>
293353
public class SoaRecord : DnsRecordBase
294354
{
355+
/// <summary>
356+
/// Gets or sets the domain name of the authoritative name server for this SOA record, without a temrinating dot.
357+
/// </summary>
295358
public string Host { get; set; }
296359

360+
/// <summary>
361+
/// Gets or sets the email for this SOA record.
362+
/// </summary>
297363
public string Email { get; set; }
298364

365+
/// <summary>
366+
/// Gets or sets the serial number of this SOA record.
367+
/// </summary>
299368
public uint SerialNumber { get; set; }
300369

370+
/// <summary>
371+
/// Gets or sets the refresh value for this SOA record.
372+
/// </summary>
301373
public uint RefreshTime { get; set; }
302374

375+
/// <summary>
376+
/// Gets or sets the retry time for SOA record.
377+
/// </summary>
303378
public uint RetryTime { get; set; }
304379

380+
/// <summary>
381+
/// Gets or sets the expire time for this SOA record.
382+
/// </summary>
305383
public uint ExpireTime { get; set; }
306384

385+
/// <summary>
386+
/// Gets or sets the minimum TTL for this SOA record.
387+
/// </summary>
307388
public uint MinimumTtl { get; set; }
308389

309390
public override string ToString()

src/ResourceManager/Dns/Commands.Dns/Records/AddAzureDnsRecordConfig.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
namespace Microsoft.Azure.Commands.Dns
2424
{
2525
/// <summary>
26-
/// Creates a new resource.
26+
/// Adds a record to a record set object.
2727
/// </summary>
2828
[Cmdlet(VerbsCommon.Add, "AzureDnsRecordConfig"), OutputType(typeof(DnsRecordSet))]
2929
public class AddAzureDnsRecordConfig : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Records/GetAzureDnsRescordSet.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
namespace Microsoft.Azure.Commands.Dns
2525
{
2626
/// <summary>
27-
/// Creates a new resource.
27+
/// Gets one or more existing record sets.
2828
/// </summary>
2929
[Cmdlet(VerbsCommon.Get, "AzureDnsRecordSet"), OutputType(typeof(DnsRecordSet))]
3030
public class GetAzureDnsRecordSet : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Records/NewAzureDnsRescordSet.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
namespace Microsoft.Azure.Commands.Dns
2323
{
2424
/// <summary>
25-
/// Creates a new resource.
25+
/// Creates a new record set.
2626
/// </summary>
2727
[Cmdlet(VerbsCommon.New, "AzureDnsRecordSet"), OutputType(typeof(DnsRecordSet))]
2828
public class NewAzureDnsRecordSet : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Records/RemoveAzureDnsRecordConfig.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
namespace Microsoft.Azure.Commands.Dns
2424
{
2525
/// <summary>
26-
/// Creates a new resource.
26+
/// Removes a record from a record set object.
2727
/// </summary>
2828
[Cmdlet(VerbsCommon.Remove, "AzureDnsRecordConfig"), OutputType(typeof(DnsRecordSet))]
2929
public class RemoveAzureDnsRecordConfig : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Records/RemoveAzureDnsRecordSet.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
namespace Microsoft.Azure.Commands.Dns
2323
{
2424
/// <summary>
25-
/// Creates a new resource.
25+
/// Deletes an existing record set.
2626
/// </summary>
2727
[Cmdlet(VerbsCommon.Remove, "AzureDnsRecordSet"), OutputType(typeof(bool))]
2828
public class RemoveAzureDnsRecordSet : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Records/SetAzureDnsRecordSet.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
namespace Microsoft.Azure.Commands.Dns
2222
{
2323
/// <summary>
24-
/// Creates a new resource.
24+
/// Updates an existing record set.
2525
/// </summary>
2626
[Cmdlet(VerbsCommon.Set, "AzureDnsRecordSet"), OutputType(typeof(DnsRecordSet))]
2727
public class SetAzureDnsRecordSet : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Zones/GetAzureDnsZone.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
namespace Microsoft.Azure.Commands.Dns
2020
{
2121
/// <summary>
22-
/// Creates a new resource.
22+
/// Gets one or more existing zones.
2323
/// </summary>
2424
[Cmdlet(VerbsCommon.Get, "AzureDnsZone"), OutputType(typeof(DnsZone))]
2525
public class GetAzureDnsZone : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Zones/NewAzureDnsZone.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
namespace Microsoft.Azure.Commands.Dns
2222
{
2323
/// <summary>
24-
/// Creates a new resource.
24+
/// Creates a new zone.
2525
/// </summary>
2626
[Cmdlet(VerbsCommon.New, "AzureDnsZone"), OutputType(typeof(DnsZone))]
2727
public class NewAzureDnsZone : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Zones/RemoveAzureDnsZone.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
namespace Microsoft.Azure.Commands.Dns
2323
{
2424
/// <summary>
25-
/// Creates a new resource.
25+
/// Deletes an existing zone.
2626
/// </summary>
2727
[Cmdlet(VerbsCommon.Remove, "AzureDnsZone"), OutputType(typeof(bool))]
2828
public class RemoveAzureDnsZone : DnsBaseCmdlet

src/ResourceManager/Dns/Commands.Dns/Zones/SetAzureDnsZone.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
namespace Microsoft.Azure.Commands.Dns
2222
{
2323
/// <summary>
24-
/// Creates a new resource.
24+
/// Updates an existing zone.
2525
/// </summary>
2626
[Cmdlet(VerbsCommon.Set, "AzureDnsZone"), OutputType(typeof(DnsZone))]
2727
public class SetAzureDnsZone : DnsBaseCmdlet

0 commit comments

Comments
 (0)