IO-226 - document rounding behaviour

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@919253 13f79535-47bb-0310-9956-ffa450edef68

Author: sebbASF

src/java/org/apache/commons/io/FileUtils.java

@@ -189,10 +189,16 @@ public static FileOutputStream openOutputStream(File file) throws IOException {
     /**
      * Returns a human-readable version of the file size, where the input
      * represents a specific number of bytes.
+     * 
+     * If the size is over 1GB, the size is returned as the number of whole GB,
+     * i.e. the size is rounded down to the nearest GB boundary.
+     * 
+     * Similarly for the 1MB and 1KB boundaries.
      *
      * @param size  the number of bytes
-     * @return a human-readable display value (includes units)
+     * @return a human-readable display value (includes units - GB, MB, KB or bytes)
      */
+    // See https://issues.apache.org/jira/browse/IO-226 - should the rounding be changed?
     public static String byteCountToDisplaySize(long size) {
         String displaySize;