Add some notes about ByteVector::isNull() and ByteVector::null.

diff --git a/taglib/toolkit/tbytevector.h b/taglib/toolkit/tbytevector.h
index 793b414cecbed35d86f9d35559660f166d70256a..98b5d8b5060dc8b69e469ab81926a55df955fc9f 100644 (file)
--- a/taglib/toolkit/tbytevector.h
+++ b/taglib/toolkit/tbytevector.h
@@ -261,7 +261,9 @@ namespace TagLib {
     /*!
      * Returns true if the vector is null.
      *
-     * \note A vector may be empty without being null.
+     * \note A vector may be empty without being null.  So do not use this
+     * method to check if the vector is empty.
+     *
      * \see isEmpty()
      */
     bool isNull() const;
@@ -565,6 +567,9 @@ namespace TagLib {
     /*!
      * A static, empty ByteVector which is convenient and fast (since returning
      * an empty or "null" value does not require instantiating a new ByteVector).
+     *
+     * \warning Do not modify this variable.  It will mess up the internal state
+     * of TagLib.
      */
     static ByteVector null;
 

diff --git a/tests/test_bytevector.cpp b/tests/test_bytevector.cpp
index 1c2ca904d0ff5fc4ea35fa67e749f239e9a29d1e..4b0c098f700f32faf3d6513a70745a843a8fcc6b 100644 (file)
--- a/tests/test_bytevector.cpp
+++ b/tests/test_bytevector.cpp
@@ -124,6 +124,10 @@ public:
     CPPUNIT_ASSERT(i.containsAt(j, 5, 0));
     CPPUNIT_ASSERT(i.containsAt(j, 6, 1));
     CPPUNIT_ASSERT(i.containsAt(j, 6, 1, 3));
+
+    i.clear();
+    CPPUNIT_ASSERT(i.isEmpty());
+    CPPUNIT_ASSERT(!i.isNull());
   }
 
   void testFind1()