Add warnings about calling File::save() repeatedly.

diff --git a/taglib/ape/apefile.h b/taglib/ape/apefile.h
index 1a64f8b5489a5eb8c8492a257341d9d445c86723..1d2e5c67502cec601766263e849714dc0b8f10db 100644 (file)
--- a/taglib/ape/apefile.h
+++ b/taglib/ape/apefile.h
@@ -146,6 +146,9 @@ namespace TagLib {
        *
        * \note According to the official Monkey's Audio SDK, an APE file
        * can only have either ID3V1 or APE tags, so a parameter is used here.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       virtual bool save();
 

diff --git a/taglib/asf/asffile.h b/taglib/asf/asffile.h
index b674da79c1479507e0f548c1dfa0ba39fd9215bf..f1ae431fe7c9c319f21717f184f995deb1f16588 100644 (file)
--- a/taglib/asf/asffile.h
+++ b/taglib/asf/asffile.h
@@ -112,6 +112,9 @@ namespace TagLib {
        * Save the file.
        *
        * This returns true if the save was successful.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       virtual bool save();
 

diff --git a/taglib/flac/flacfile.h b/taglib/flac/flacfile.h
index dc0a9601734055be33d9e4e71a456d38a2e3f4ad..1c055d3392d8186829c6840ea9a9cfa2e534156c 100644 (file)
--- a/taglib/flac/flacfile.h
+++ b/taglib/flac/flacfile.h
@@ -155,6 +155,9 @@ namespace TagLib {
        * has no XiphComment, one will be constructed from the ID3-tags.
        *
        * This returns true if the save was successful.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       virtual bool save();
 

diff --git a/taglib/mp4/mp4file.h b/taglib/mp4/mp4file.h
index 28880f8444b3325b69ca0f35c4a22f4274bc7149..791a019234fb7e381943822191b3c413370d1e89 100644 (file)
--- a/taglib/mp4/mp4file.h
+++ b/taglib/mp4/mp4file.h
@@ -111,6 +111,9 @@ namespace TagLib {
        * Save the file.
        *
        * This returns true if the save was successful.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       bool save();
 

diff --git a/taglib/mpc/mpcfile.h b/taglib/mpc/mpcfile.h
index df5d43561b1df90f479e6260ce62f893daf09adf..0980a5cd3656fd4ffc48f57e2c075947812f4d8b 100644 (file)
--- a/taglib/mpc/mpcfile.h
+++ b/taglib/mpc/mpcfile.h
@@ -139,6 +139,11 @@ namespace TagLib {
 
       /*!
        * Saves the file.
+       *
+       * This returns true if the save was successful.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       virtual bool save();
 

diff --git a/taglib/mpeg/mpegfile.h b/taglib/mpeg/mpegfile.h
index 1790807370c926d7eeea03af7ceaa0391b93f018..858a6a5ca981d38e0c263634efa791ca9872e6df 100644 (file)
--- a/taglib/mpeg/mpegfile.h
+++ b/taglib/mpeg/mpegfile.h
@@ -175,6 +175,9 @@ namespace TagLib {
        * If you would like more granular control over the content of the tags,
        * with the concession of generality, use parameterized save call below.
        *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
+       *
        * \see save(int tags)
        */
       virtual bool save();
@@ -187,6 +190,9 @@ namespace TagLib {
        * This strips all tags not included in the mask, but does not modify them
        * in memory, so later calls to save() which make use of these tags will
        * remain valid.  This also strips empty tags.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       bool save(int tags);
 
@@ -198,6 +204,9 @@ namespace TagLib {
        * If \a stripOthers is true this strips all tags not included in the mask,
        * but does not modify them in memory, so later calls to save() which make
        * use of these tags will remain valid.  This also strips empty tags.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       // BIC: combine with the above method
       bool save(int tags, bool stripOthers);
@@ -213,6 +222,9 @@ namespace TagLib {
        *
        * The \a id3v2Version parameter specifies the version of the saved
        * ID3v2 tag. It can be either 4 or 3.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       // BIC: combine with the above method
       bool save(int tags, bool stripOthers, int id3v2Version);
@@ -231,6 +243,9 @@ namespace TagLib {
        *
        * If \a duplicateTags is true and at least one tag -- ID3v1 or ID3v2 --
        * exists this will duplicate its content into the other tag.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       // BIC: combine with the above method
       bool save(int tags, bool stripOthers, int id3v2Version, bool duplicateTags);

diff --git a/taglib/ogg/flac/oggflacfile.h b/taglib/ogg/flac/oggflacfile.h
index 05762f9b828b415fafc6fddee0ffdf708ffb04e3..28b3f67f8cce78ab790679a2c57370f167533215 100644 (file)
--- a/taglib/ogg/flac/oggflacfile.h
+++ b/taglib/ogg/flac/oggflacfile.h
@@ -127,6 +127,9 @@ namespace TagLib {
       /*!
        * Save the file.  This will primarily save and update the XiphComment.
        * Returns true if the save is successful.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  It leads to a segfault.
        */
       virtual bool save();
 

diff --git a/taglib/ogg/opus/opusfile.h b/taglib/ogg/opus/opusfile.h
index 2b86f3f32b530cefaa9774bee78538f1ea27825b..0363b58460b7e6bf08fd3ab7282243d7a7e0bf06 100644 (file)
--- a/taglib/ogg/opus/opusfile.h
+++ b/taglib/ogg/opus/opusfile.h
@@ -106,6 +106,14 @@ namespace TagLib {
          */
         virtual Properties *audioProperties() const;
 
+        /*!
+         * Save the file.
+         *
+         * This returns true if the save was successful.
+         *
+         * \warning In the current implementation, it's dangerous to call save()
+         * repeatedly.  It leads to a segfault.
+         */
         virtual bool save();
 
       private:

diff --git a/taglib/ogg/speex/speexfile.h b/taglib/ogg/speex/speexfile.h
index cc4ae24075d46b19d459be1d88ad248873c98279..de38bfbfccaa2adadbf7dcb9edfb2d3c83721149 100644 (file)
--- a/taglib/ogg/speex/speexfile.h
+++ b/taglib/ogg/speex/speexfile.h
@@ -106,8 +106,14 @@ namespace TagLib {
          */
         virtual Properties *audioProperties() const;
 
-
-
+        /*!
+         * Save the file.
+         *
+         * This returns true if the save was successful.
+         *
+         * \warning In the current implementation, it's dangerous to call save()
+         * repeatedly.  It leads to a segfault.
+         */
         virtual bool save();
 
       private:

diff --git a/taglib/ogg/vorbis/vorbisfile.h b/taglib/ogg/vorbis/vorbisfile.h
index 9603ee9a1ffafba006854d8b241944bf90a85fd8..48d9d7ca2bebcd149f91f937849d017f09f5a786 100644 (file)
--- a/taglib/ogg/vorbis/vorbisfile.h
+++ b/taglib/ogg/vorbis/vorbisfile.h
@@ -114,6 +114,14 @@ namespace TagLib {
        */
       virtual Properties *audioProperties() const;
 
+      /*!
+       * Save the file.
+       *
+       * This returns true if the save was successful.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  It leads to a segfault.
+       */
       virtual bool save();
 
     private:

diff --git a/taglib/wavpack/wavpackfile.h b/taglib/wavpack/wavpackfile.h
index 2e51bd1dd4791e4ba38fdcb4fe4dd4d0bab29fe1..24511581bb0fb45128497f31c2e0ed4997c1a02a 100644 (file)
--- a/taglib/wavpack/wavpackfile.h
+++ b/taglib/wavpack/wavpackfile.h
@@ -133,6 +133,11 @@ namespace TagLib {
 
       /*!
        * Saves the file.
+       *
+       * This returns true if the save was successful.
+       *
+       * \warning In the current implementation, it's dangerous to call save()
+       * repeatedly.  At worst it will corrupt the file.
        */
       virtual bool save();