[commons-net] branch master updated: Clarify behaviour of setInclusiveHostCount

[sebb]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git


The following commit(s) were added to refs/heads/master by this push:
     new 29a2231  Clarify behaviour of setInclusiveHostCount
29a2231 is described below

commit 29a22319a843f0520b6e2637808ed89d6abdb306
Author: Sebb <s...@apache.org>
AuthorDate: Tue Jun 23 15:35:28 2020 +0100

    Clarify behaviour of setInclusiveHostCount
---
 src/main/java/org/apache/commons/net/util/SubnetUtils.java | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/net/util/SubnetUtils.java 
b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
index 61e1aeb..4aa38f3 100644
--- a/src/main/java/org/apache/commons/net/util/SubnetUtils.java
+++ b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
@@ -112,6 +112,7 @@ public class SubnetUtils {
     /**
      * Set to <code>true</code> if you want the return value of {@link 
SubnetInfo#getAddressCount()}
      * to include the network and broadcast addresses.
+     * This also applies to {@link SubnetUtils.SubnetInfo#isInRange()}
      * @param inclusiveHostCount true if network and broadcast addresses are 
to be included
      * @since 2.2
      */
@@ -148,7 +149,8 @@ public class SubnetUtils {
         /**
          * Returns true if the parameter <code>address</code> is in the
          * range of usable endpoint addresses for this subnet. This excludes 
the
-         * network and broadcast addresses.
+         * network and broadcast addresses. Use {@link 
SubnetUtils.setInclusiveHostCount()}
+         * to change this.
          * @param address A dot-delimited IPv4 address, e.g. "192.168.0.1"
          * @return True if in range, false otherwise
          */
@@ -159,7 +161,8 @@ public class SubnetUtils {
         /**
          * Returns true if the parameter <code>address</code> is in the
          * range of usable endpoint addresses for this subnet. This excludes 
the
-         * network and broadcast addresses.
+         * network and broadcast addresses by default. Use {@link 
SubnetUtils.setInclusiveHostCount()}
+         * to change this.
          * @param address the address to check
          * @return true if it is in range
          * @since 3.4 (made public)