Skip to content

Commit

Permalink
Fix : warnings on missing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lduchosal committed Aug 16, 2022
1 parent 68e343b commit 41cad73
Show file tree
Hide file tree
Showing 8 changed files with 289 additions and 186 deletions.
4 changes: 4 additions & 0 deletions src/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[*.cs]

# CS1591: Missing XML comment for publicly visible type or member
dotnet_diagnostic.CS1591.severity = suggestion
3 changes: 3 additions & 0 deletions src/Gnu.Getopt/Gnu.Getopt.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,8 @@
<SignAssembly Condition=" '$(OS)' != 'Windows_NT' ">false</SignAssembly>
<AssemblyOriginatorKeyFile>System.Net.IPNetwork.snk</AssemblyOriginatorKeyFile>
</PropertyGroup>
<ItemGroup>
<None Include="..\.editorconfig" Link=".editorconfig" />
</ItemGroup>

</Project>
3 changes: 3 additions & 0 deletions src/System.Net.IPNetwork/CidrClassFull.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@

namespace System.Net
{
/// <summary>
/// Class <c>CidrClassFull</c> tries to guess CIDR in a ClassFull way.
/// </summary>
public sealed class CidrClassFull : ICidrGuess
{
/// <summary>
Expand Down
4 changes: 3 additions & 1 deletion src/System.Net.IPNetwork/CidrClassLess.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace System.Net
{

/// <summary>
/// Try to guess a CIDR in a ClassLess way ie. ipv4 = 32, ipv6 = 128
/// </summary>
public sealed class CidrClassLess : ICidrGuess
{
/// <summary>
Expand Down
18 changes: 18 additions & 0 deletions src/System.Net.IPNetwork/CidrGuess.cs
Original file line number Diff line number Diff line change
@@ -1,12 +1,30 @@
namespace System.Net
{
/// <summary>
///
/// </summary>
public interface ICidrGuess {
/// <summary>
///
/// </summary>
/// <param name="ip"></param>
/// <param name="cidr"></param>
/// <returns></returns>
bool TryGuessCidr(string ip, out byte cidr);

}
/// <summary>
///
/// </summary>
public static class CidrGuess
{
/// <summary>
///
/// </summary>
public static ICidrGuess ClassFull { get => _cidr_classfull.Value; }
/// <summary>
///
/// </summary>
public static ICidrGuess ClassLess { get => _cidr_classless.Value; }

private static readonly Lazy<ICidrGuess> _cidr_classless = new Lazy<ICidrGuess>(() => new CidrClassLess());
Expand Down
12 changes: 9 additions & 3 deletions src/System.Net.IPNetwork/IPAddressCollection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

namespace System.Net
{

public enum FilterEnum
{
All,
Usable
}

/// <summary>
///
/// </summary>
public class IPAddressCollection : IEnumerable<IPAddress>, IEnumerator<IPAddress> {

private readonly IPNetwork _ipnetwork;
Expand Down Expand Up @@ -82,12 +84,16 @@ public bool MoveNext()
}
return true;
}

/// <summary>
///
/// </summary>
public void Reset()
{
_enumerator = -1;
}

/// <summary>
///
/// </summary>
public void Dispose()
{
// nothing to dispose
Expand Down
Loading

0 comments on commit 41cad73

Please sign in to comment.