Add note to ScalaDoc

scodec · May 1, 2024 · 49cffb4 · 49cffb4
1 parent 2384918
commit 49cffb4
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/core/shared/src/main/scala/scodec/bits/ByteVector.scala b/core/shared/src/main/scala/scodec/bits/ByteVector.scala
@@ -1753,6 +1753,10 @@ object ByteVector extends ByteVectorCompanionCrossPlatform {
     * is not valid hexadecimal.
     *
     * The string may start with a `0x` and it may contain whitespace or underscore characters.
+    *
+    * Single-line comments are supported - by default, any text after a #, ;, or | charater is ignored
+    * until the start of the next line, though comment charaters are specified by the specified alphabet.
+    *
     * @group base
     */
   def fromHexDescriptive(
@@ -1858,6 +1862,10 @@ object ByteVector extends ByteVectorCompanionCrossPlatform {
     * not valid binary.
     *
     * The string may start with a `0b` and it may contain whitespace or underscore characters.
+    *
+    * Single-line comments are supported - by default, any text after a #, ;, or | charater is ignored
+    * until the start of the next line, though comment charaters are specified by the specified alphabet.
+    *
     * @group base
     */
   def fromBinDescriptive(