Skip to content

Commit

Permalink
Readme update - url fix
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaCo committed Jun 20, 2021
1 parent de7fc4c commit 3c37a2c
Show file tree
Hide file tree
Showing 33 changed files with 46 additions and 80 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ DnsClient.NET is a simple yet very powerful and high performance open source lib

## Usage

See http://dnsclient.michaco.net for more details and documentation.
See [the DnsClient site][dnsclient] for more details and documentation.

The following example instantiates a new `LookupClient` to query some IP address.

Expand Down Expand Up @@ -57,6 +57,7 @@ Just clone the repository and open the solution in Visual Studio 2019.
## Examples

* See [MiniDig](https://github.com/MichaCo/DnsClient.NET/tree/dev/samples/MiniDig)'s readme for what this example command line tool can do.
* More documentation and a simple query window on http://dnsclient.michaco.net
* [More documentation and examples][dnsclient]
* The [Samples](https://github.com/MichaCo/DnsClient.NET.Samples) repository (there might be more in the future).

[dnsclient]:https://dnsclient.michaco.net
2 changes: 1 addition & 1 deletion samples/MiniDig/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public class Program
{
public static async Task<int> Main(string[] args)
{
DnsClient.Tracing.Source.Switch.Level = SourceLevels.Information;
DnsClient.Tracing.Source.Switch.Level = SourceLevels.Warning;
DnsClient.Tracing.Source.Listeners.Add(new ConsoleTraceListener());

var app = new CommandLineApplication(throwOnUnexpectedArg: true);
Expand Down
4 changes: 2 additions & 2 deletions src/DnsClient/DnsQueryExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -738,9 +738,9 @@ public static ServiceHostEntry[] ResolveServiceProcessResult(IDnsQueryResponse r
}

/// <summary>
/// Extends <see cref="IPHostEntry"/> by the <see cref="ServiceHostEntry.Port"/> property.
/// Extends <see cref="IPHostEntry"/> by the <see cref="Port"/> property.
/// </summary>
/// <seealso cref="System.Net.IPHostEntry" />
/// <seealso cref="IPHostEntry" />
public class ServiceHostEntry : IPHostEntry
{
/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions src/DnsClient/DnsQueryOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ public class DnsQueryOptions
/// <summary>
/// Gets or sets the request timeout in milliseconds. <see cref="Timeout"/> is used for limiting the connection and request time for one operation.
/// Timeout must be greater than zero and less than <see cref="int.MaxValue"/>.
/// If <see cref="System.Threading.Timeout.InfiniteTimeSpan"/> (or -1) is used, no timeout will be applied.
/// If <see cref="Timeout.InfiniteTimeSpan"/> (or -1) is used, no timeout will be applied.
/// Default is 5 seconds.
/// </summary>
/// <remarks>
Expand Down Expand Up @@ -579,7 +579,7 @@ public class DnsQuerySettings : IEquatable<DnsQuerySettings>
/// <summary>
/// Gets the request timeout in milliseconds. <see cref="Timeout"/> is used for limiting the connection and request time for one operation.
/// Timeout must be greater than zero and less than <see cref="int.MaxValue"/>.
/// If <see cref="System.Threading.Timeout.InfiniteTimeSpan"/> (or -1) is used, no timeout will be applied.
/// If <see cref="Timeout.InfiniteTimeSpan"/> (or -1) is used, no timeout will be applied.
/// Default is 5 seconds.
/// </summary>
/// <remarks>
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/DnsResponseCode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ public enum DnsResponseCode
/// <summary>
/// A DnsClient specific exception transporting additional information about the query causing this exception.
/// </summary>
/// <seealso cref="System.Exception" />
/// <seealso cref="Exception" />
#if !NETSTANDARD1_3
[Serializable]
#endif
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Internal/ILogger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ public interface ILogger
}
}

#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
2 changes: 1 addition & 1 deletion src/DnsClient/Internal/ILoggerFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ public interface ILoggerFactory
}
}

#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
2 changes: 1 addition & 1 deletion src/DnsClient/Internal/LogLevel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ public enum LogLevel
}
}

#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
2 changes: 1 addition & 1 deletion src/DnsClient/Internal/LoggerExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,4 @@ public static void Log(this ILogger logger, LogLevel logLevel, Exception excepti
}
}

#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
2 changes: 1 addition & 1 deletion src/DnsClient/Internal/NullLoggerFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ public void Log(LogLevel logLevel, int eventId, Exception exception, string mess
}
}
}
}
}
8 changes: 4 additions & 4 deletions src/DnsClient/Internal/StringBuilderObjectPool.cs
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ internal abstract class ObjectPoolProvider
{
public ObjectPool<T> Create<T>() where T : class, new()
{
return Create<T>(new DefaultPooledObjectPolicy<T>());
return Create(new DefaultPooledObjectPolicy<T>());
}

public abstract ObjectPool<T> Create<T>(IPooledObjectPolicy<T> policy) where T : class;
Expand Down Expand Up @@ -210,7 +210,7 @@ internal static class ObjectPoolProviderExtensions
{
public static ObjectPool<StringBuilder> CreateStringBuilderPool(this ObjectPoolProvider provider)
{
return provider.Create<StringBuilder>(new StringBuilderPooledObjectPolicy());
return provider.Create(new StringBuilderPooledObjectPolicy());
}

public static ObjectPool<StringBuilder> CreateStringBuilderPool(
Expand All @@ -224,9 +224,9 @@ public static ObjectPool<StringBuilder> CreateStringBuilderPool(
MaximumRetainedCapacity = maximumRetainedCapacity,
};

return provider.Create<StringBuilder>(policy);
return provider.Create(policy);
}
}
}

#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
2 changes: 1 addition & 1 deletion src/DnsClient/Interop/DisposableIntPtr.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ public void Dispose()
Marshal.FreeHGlobal(_ptr);
}
}
}
}
4 changes: 2 additions & 2 deletions src/DnsClient/IpAddressExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ public static class IpAddressExtensions
/// </summary>
/// <param name="ip">The address to translate.</param>
/// <returns>The arpa representation of the address.</returns>
/// <seealso cref="DnsClient.IDnsQuery.QueryReverse(IPAddress)"/>
/// <seealso cref="DnsClient.IDnsQuery.QueryReverseAsync(IPAddress, Threading.CancellationToken)"/>
/// <seealso cref="IDnsQuery.QueryReverse(IPAddress)"/>
/// <seealso cref="IDnsQuery.QueryReverseAsync(IPAddress, Threading.CancellationToken)"/>
/// <seealso href="https://en.wikipedia.org/wiki/.arpa"/>
public static string GetArpaName(this IPAddress ip)
{
Expand Down
4 changes: 2 additions & 2 deletions src/DnsClient/Protocol/AddressRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public class AddressRecord : DnsResourceRecord
/// <param name="info">The information.</param>
/// <param name="address">The address.</param>
/// <exception cref="ArgumentNullException">If <paramref name="info"/> is null.</exception>
/// <exception cref="System.ArgumentNullException">If <paramref name="address"/> or <paramref name="info"/> is null</exception>
/// <exception cref="ArgumentNullException">If <paramref name="address"/> or <paramref name="info"/> is null</exception>
public AddressRecord(ResourceRecordInfo info, IPAddress address)
: base(info)
{
Expand All @@ -37,4 +37,4 @@ private protected override string RecordToString()
return Address.ToString();
}
}
}
}
4 changes: 2 additions & 2 deletions src/DnsClient/Protocol/AfsDbRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public class AfsDbRecord : DnsResourceRecord
/// <param name="info">The information.</param>
/// <param name="type">The type.</param>
/// <param name="name">The name.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="info"/> or <paramref name="name"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="info"/> or <paramref name="name"/> is null.</exception>
public AfsDbRecord(ResourceRecordInfo info, AfsType type, DnsString name) : base(info)
{
SubType = type;
Expand Down Expand Up @@ -80,4 +80,4 @@ public enum AfsType
/// </summary>
Dce = 2
}
}
}
4 changes: 2 additions & 2 deletions src/DnsClient/Protocol/CNameRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public class CNameRecord : DnsResourceRecord
/// </summary>
/// <param name="info">The information.</param>
/// <param name="canonicalName">The canonical name.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="canonicalName"/> or <paramref name="info"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="canonicalName"/> or <paramref name="info"/> is null.</exception>
public CNameRecord(ResourceRecordInfo info, DnsString canonicalName)
: base(info)
{
Expand All @@ -53,4 +53,4 @@ private protected override string RecordToString()
return CanonicalName.Value;
}
}
}
}
4 changes: 2 additions & 2 deletions src/DnsClient/Protocol/CaaRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public class CaaRecord : DnsResourceRecord
/// <param name="flags">The flags.</param>
/// <param name="tag">The tag.</param>
/// <param name="value">The value.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="info"/> or <paramref name="tag"/> or <paramref name="value"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="info"/> or <paramref name="tag"/> or <paramref name="value"/> is null.</exception>
public CaaRecord(ResourceRecordInfo info, byte flags, string tag, string value) : base(info)
{
Flags = flags;
Expand All @@ -128,4 +128,4 @@ private protected override string RecordToString()
return $"{Flags} {Tag} \"{Value}\"";
}
}
}
}
4 changes: 2 additions & 2 deletions src/DnsClient/Protocol/DnsResourceRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace DnsClient.Protocol
/// <summary>
/// Base class for all resource records.
/// </summary>
/// <seealso cref="DnsClient.Protocol.ResourceRecordInfo" />
/// <seealso cref="ResourceRecordInfo" />
public abstract class DnsResourceRecord : ResourceRecordInfo
{
/// <summary>
Expand Down Expand Up @@ -128,7 +128,7 @@ public ResourceRecordInfo(string domainName, ResourceRecordType recordType, Quer
/// <param name="recordClass">The record class.</param>
/// <param name="timeToLive">The time to live.</param>
/// <param name="rawDataLength">Length of the raw data.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="domainName" /> is null or empty.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="domainName" /> is null or empty.</exception>
public ResourceRecordInfo(DnsString domainName, ResourceRecordType recordType, QueryClass recordClass, int timeToLive, int rawDataLength)
{
DomainName = domainName ?? throw new ArgumentNullException(nameof(domainName));
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/EmptyRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/// A <see cref="DnsResourceRecord"/> not representing any specific resource record.
/// Used if unsupported <see cref="ResourceRecordType"/>s are found in the result.
/// </summary>
/// <seealso cref="DnsClient.Protocol.DnsResourceRecord" />
/// <seealso cref="DnsResourceRecord" />
public class EmptyRecord : DnsResourceRecord
{
/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/HinfoRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public class HInfoRecord : DnsResourceRecord
/// <param name="info">The information.</param>
/// <param name="cpu">The CPU.</param>
/// <param name="os">The OS.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="info"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="info"/> is null.</exception>
public HInfoRecord(ResourceRecordInfo info, string cpu, string os)
: base(info)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/MXRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public class MxRecord : DnsResourceRecord
/// <param name="info">The information.</param>
/// <param name="preference">The preference.</param>
/// <param name="domainName">Name of the domain.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="domainName"/> or <paramref name="info"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="domainName"/> or <paramref name="info"/> is null.</exception>
public MxRecord(ResourceRecordInfo info, ushort preference, DnsString domainName)
: base(info)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/MbRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class MbRecord : DnsResourceRecord
/// </summary>
/// <param name="info">The information.</param>
/// <param name="domainName">The domain name.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="domainName"/> or <paramref name="info"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="domainName"/> or <paramref name="info"/> is null.</exception>
public MbRecord(ResourceRecordInfo info, DnsString domainName)
: base(info)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/MgRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public class MgRecord : DnsResourceRecord
/// </summary>
/// <param name="info">The information.</param>
/// <param name="domainName">The domain name.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="domainName"/> or <paramref name="info"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="domainName"/> or <paramref name="info"/> is null.</exception>
public MgRecord(ResourceRecordInfo info, DnsString domainName)
: base(info)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/MrRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class MrRecord : DnsResourceRecord
/// </summary>
/// <param name="info">The information.</param>
/// <param name="name">The domain name.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="name"/> or <paramref name="info"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="name"/> or <paramref name="info"/> is null.</exception>
public MrRecord(ResourceRecordInfo info, DnsString name)
: base(info)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/NsRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class NsRecord : DnsResourceRecord
/// </summary>
/// <param name="info">The information.</param>
/// <param name="name">The name.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="name"/> or <paramref name="info"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="name"/> or <paramref name="info"/> is null.</exception>
public NsRecord(ResourceRecordInfo info, DnsString name)
: base(info)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/Options/OptRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,4 @@ private protected override string RecordToString()
}
}
}
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
4 changes: 2 additions & 2 deletions src/DnsClient/Protocol/PtrRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ in special domains to point to some other location in the domain space.
/// A <see cref="DnsResourceRecord"/> representing a pointer. These RRs are used
/// in special domains to point to some other location in the domain space.
/// </summary>
/// <seealso cref="DnsClient.Protocol.DnsResourceRecord" />
/// <seealso cref="DnsResourceRecord" />
/// <seealso href="https://tools.ietf.org/html/rfc1035#section-3.3.12">RFC 1035</seealso>
public class PtrRecord : DnsResourceRecord
{
Expand All @@ -43,7 +43,7 @@ public class PtrRecord : DnsResourceRecord
/// </summary>
/// <param name="info">The information.</param>
/// <param name="ptrDomainName">The domain name.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="info"/> or <paramref name="ptrDomainName"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="info"/> or <paramref name="ptrDomainName"/> is null.</exception>
public PtrRecord(ResourceRecordInfo info, DnsString ptrDomainName)
: base(info)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/RpRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public class RpRecord : DnsResourceRecord
/// <param name="info">The information.</param>
/// <param name="mailbox">The mailbox domain.</param>
/// <param name="textName">The text domain.</param>
/// <exception cref="System.ArgumentNullException">
/// <exception cref="ArgumentNullException">
/// If <paramref name="info"/> or <paramref name="mailbox"/> or <paramref name="textName"/> is null.
/// </exception>
public RpRecord(ResourceRecordInfo info, DnsString mailbox, DnsString textName)
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/SoaRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ public class SoaRecord : DnsResourceRecord
/// <param name="retry">The retry time.</param>
/// <param name="expire">The expire time.</param>
/// <param name="minimum">The minimum TTL.</param>
/// <exception cref="System.ArgumentNullException">
/// <exception cref="ArgumentNullException">
/// If <paramref name="info"/> or <paramref name="mName"/> or <paramref name="rName"/> is null.
/// </exception>
public SoaRecord(ResourceRecordInfo info, DnsString mName, DnsString rName, uint serial, uint refresh, uint retry, uint expire, uint minimum)
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/SrvRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ public class SrvRecord : DnsResourceRecord
/// <param name="weight">The weight.</param>
/// <param name="port">The port.</param>
/// <param name="target">The target.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="info"/> or <paramref name="target"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="info"/> or <paramref name="target"/> is null.</exception>
public SrvRecord(ResourceRecordInfo info, ushort priority, ushort weight, ushort port, DnsString target)
: base(info)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/TxtRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public class TxtRecord : DnsResourceRecord
/// <param name="info">The information.</param>
/// <param name="values">The values.</param>
/// <param name="utf8Values">The UTF8 values.</param>
/// <exception cref="System.ArgumentNullException">
/// <exception cref="ArgumentNullException">
/// If <paramref name="info"/> or <paramref name="utf8Values"/> or <paramref name="values"/> is null.
/// </exception>
public TxtRecord(ResourceRecordInfo info, string[] values, string[] utf8Values)
Expand Down
2 changes: 1 addition & 1 deletion src/DnsClient/Protocol/UriRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public class UriRecord : DnsResourceRecord
/// <param name="priority">The priority.</param>
/// <param name="weight">The weight.</param>
/// <param name="target">The target.</param>
/// <exception cref="System.ArgumentNullException">If <paramref name="info"/> or <paramref name="target"/> is null.</exception>
/// <exception cref="ArgumentNullException">If <paramref name="info"/> or <paramref name="target"/> is null.</exception>
public UriRecord(ResourceRecordInfo info, int priority, int weight, string target)
: base(info)
{
Expand Down
Loading

0 comments on commit 3c37a2c

Please sign in to comment.