lib/standard/bytes: added documentation for public methods

Signed-off-by: Lucas Bajolet <r4pass@hotmail.com>

diff --git a/lib/standard/bytes.nit b/lib/standard/bytes.nit
index 21d54d0..9843ddc 100644 (file)
--- a/lib/standard/bytes.nit
+++ b/lib/standard/bytes.nit
@@ -46,6 +46,7 @@ class Bytes
                init(ns, 0, 0)
        end
 
+       # Init a `Bytes` with capacity `cap`
        init with_capacity(cap: Int) do
                var ns = new NativeString(cap)
                init(ns, 0, cap)
@@ -169,6 +170,7 @@ private class BytesIterator
 end
 
 redef class NativeString
+       # Creates a new `Bytes` object from `self` with `strlen` as length
        fun to_bytes: Bytes do
                var len = cstring_length
                return new Bytes(self, len, len)

diff --git a/tests/sav/nitpick_args1.res b/tests/sav/nitpick_args1.res
index 6e97e37..ba7c7ea 100644 (file)
--- a/tests/sav/nitpick_args1.res
+++ b/tests/sav/nitpick_args1.res
@@ -1,5 +1,3 @@
-../lib/standard/bytes.nit:49,7--19: Documentation warning: Undocumented property `with_capacity`
-../lib/standard/bytes.nit:162,6--13: Documentation warning: Undocumented property `to_bytes`
 ../lib/standard/stream.nit:426,6--17: Documentation warning: Undocumented property `buffer_reset`
 ../lib/standard/file.nit:455,6--19: Documentation warning: Undocumented property `read_all_bytes`
 test_advice_repeated_types.nit:36,15--20: Warning: useless type repetition on redefined attribute `_a`