diff --git a/taglib/ape/apeproperties.h b/taglib/ape/apeproperties.h index ebbf949b..c279b59b 100644 --- a/taglib/ape/apeproperties.h +++ b/taglib/ape/apeproperties.h @@ -53,7 +53,7 @@ namespace TagLib { * Create an instance of APE::Properties with the data read from the * APE::File \a file. * - * \deprecated + * \deprecated Use Properties(File *, long, ReadStyle). */ TAGLIB_DEPRECATED Properties(File *file, ReadStyle style = Average); @@ -74,7 +74,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/asf/asfproperties.h b/taglib/asf/asfproperties.h index 317bf104..5aa453f8 100644 --- a/taglib/asf/asfproperties.h +++ b/taglib/asf/asfproperties.h @@ -86,7 +86,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/asf/asftag.h b/taglib/asf/asftag.h index bbd98212..ca06868e 100644 --- a/taglib/asf/asftag.h +++ b/taglib/asf/asftag.h @@ -152,7 +152,8 @@ namespace TagLib { virtual bool isEmpty() const; /*! - * \deprecated + * \deprecated Use attributeListMap() const, contains(), removeItem(), + * attribute(), setAttribute(), addAttribute(). */ AttributeListMap &attributeListMap(); diff --git a/taglib/fileref.h b/taglib/fileref.h index 75d14926..db23bbbb 100644 --- a/taglib/fileref.h +++ b/taglib/fileref.h @@ -278,7 +278,7 @@ namespace TagLib { * \note You generally shouldn't use this method, but instead the constructor * directly. * - * \deprecated + * \deprecated Use FileRef(FileName, bool, AudioProperties::ReadStyle). */ static File *create(FileName fileName, bool readAudioProperties = true, diff --git a/taglib/flac/flacfile.h b/taglib/flac/flacfile.h index 1b8654eb..9346d9b4 100644 --- a/taglib/flac/flacfile.h +++ b/taglib/flac/flacfile.h @@ -238,7 +238,7 @@ namespace TagLib { * when * * \see ID3v2FrameFactory - * \deprecated This value should be passed in via the constructor + * \deprecated This value should be passed in via the constructor. */ TAGLIB_DEPRECATED void setID3v2FrameFactory(const ID3v2::FrameFactory *factory); diff --git a/taglib/flac/flacproperties.h b/taglib/flac/flacproperties.h index 743e5872..17e00425 100644 --- a/taglib/flac/flacproperties.h +++ b/taglib/flac/flacproperties.h @@ -70,7 +70,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; @@ -118,7 +118,7 @@ namespace TagLib { * * \note This method is just an alias of bitsPerSample(). * - * \deprecated + * \deprecated Use bitsPerSample(). */ TAGLIB_DEPRECATED int sampleWidth() const; diff --git a/taglib/mp4/mp4properties.h b/taglib/mp4/mp4properties.h index 492a48cc..d4a1f263 100644 --- a/taglib/mp4/mp4properties.h +++ b/taglib/mp4/mp4properties.h @@ -55,7 +55,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/mp4/mp4tag.h b/taglib/mp4/mp4tag.h index 2f551140..ab70e84b 100644 --- a/taglib/mp4/mp4tag.h +++ b/taglib/mp4/mp4tag.h @@ -40,7 +40,7 @@ namespace TagLib { namespace MP4 { /*! - * \deprecated + * \deprecated Use ItemMap. */ TAGLIB_DEPRECATED typedef TagLib::Map ItemListMap; typedef TagLib::Map ItemMap; @@ -72,7 +72,7 @@ namespace TagLib { virtual bool isEmpty() const; /*! - * \deprecated Use the item() and setItem() API instead + * \deprecated Use the item() and setItem() API instead. */ TAGLIB_DEPRECATED ItemMap &itemListMap(); diff --git a/taglib/mpc/mpcfile.h b/taglib/mpc/mpcfile.h index eb3ec54a..cc62262a 100644 --- a/taglib/mpc/mpcfile.h +++ b/taglib/mpc/mpcfile.h @@ -195,7 +195,7 @@ namespace TagLib { void strip(int tags = AllTags); /*! - * \deprecated + * \deprecated Use strip(). * \see strip */ TAGLIB_DEPRECATED void remove(int tags = AllTags); diff --git a/taglib/mpc/mpcproperties.h b/taglib/mpc/mpcproperties.h index 9a902dc9..b7143ee8 100644 --- a/taglib/mpc/mpcproperties.h +++ b/taglib/mpc/mpcproperties.h @@ -72,7 +72,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/mpeg/id3v2/id3v2frame.h b/taglib/mpeg/id3v2/id3v2frame.h index 2e744fc5..e3a3db32 100644 --- a/taglib/mpeg/id3v2/id3v2frame.h +++ b/taglib/mpeg/id3v2/id3v2frame.h @@ -505,7 +505,7 @@ namespace TagLib { ByteVector render() const; /*! - * \deprecated + * \deprecated Use fileAlterPreservation(). */ TAGLIB_DEPRECATED bool frameAlterPreservation() const; diff --git a/taglib/mpeg/id3v2/id3v2framefactory.h b/taglib/mpeg/id3v2/id3v2framefactory.h index 9605c788..706f9da5 100644 --- a/taglib/mpeg/id3v2/id3v2framefactory.h +++ b/taglib/mpeg/id3v2/id3v2framefactory.h @@ -87,7 +87,7 @@ namespace TagLib { TAGLIB_DEPRECATED Frame *createFrame(const ByteVector &data, unsigned int version = 4) const; /*! - * \deprecated + * \deprecated Use createFrame(const ByteVector &, const Header *) const. */ // BIC: remove Frame *createFrame(const ByteVector &data, Header *tagHeader) const; diff --git a/taglib/mpeg/id3v2/id3v2tag.h b/taglib/mpeg/id3v2/id3v2tag.h index 74d1df1e..7b0f8367 100644 --- a/taglib/mpeg/id3v2/id3v2tag.h +++ b/taglib/mpeg/id3v2/id3v2tag.h @@ -338,7 +338,7 @@ namespace TagLib { ByteVector render() const; /*! - * \deprecated + * \deprecated Use render(Version) const. */ TAGLIB_DEPRECATED ByteVector render(int version) const; diff --git a/taglib/mpeg/mpegfile.h b/taglib/mpeg/mpegfile.h index 3fcb7272..31cf34ce 100644 --- a/taglib/mpeg/mpegfile.h +++ b/taglib/mpeg/mpegfile.h @@ -193,19 +193,19 @@ namespace TagLib { bool save(int tags); /*! - * \deprecated + * \deprecated Use save(int, StripTags, ID3v2::Version, DuplicateTags). */ // BIC: combine with the above method TAGLIB_DEPRECATED bool save(int tags, bool stripOthers); /*! - * \deprecated + * \deprecated Use save(int, StripTags, ID3v2::Version, DuplicateTags). */ // BIC: combine with the above method TAGLIB_DEPRECATED bool save(int tags, bool stripOthers, int id3v2Version); /*! - * \deprecated + * \deprecated Use save(int, StripTags, ID3v2::Version, DuplicateTags). */ // BIC: combine with the above method TAGLIB_DEPRECATED bool save(int tags, bool stripOthers, int id3v2Version, bool duplicateTags); @@ -315,7 +315,7 @@ namespace TagLib { * Set the ID3v2::FrameFactory to something other than the default. * * \see ID3v2FrameFactory - * \deprecated This value should be passed in via the constructor + * \deprecated This value should be passed in via the constructor. */ TAGLIB_DEPRECATED void setID3v2FrameFactory(const ID3v2::FrameFactory *factory); diff --git a/taglib/mpeg/mpegheader.h b/taglib/mpeg/mpegheader.h index ca51184c..35902cf2 100644 --- a/taglib/mpeg/mpegheader.h +++ b/taglib/mpeg/mpegheader.h @@ -50,7 +50,7 @@ namespace TagLib { /*! * Parses an MPEG header based on \a data. * - * \deprecated + * \deprecated Use Header(File *, long, bool). */ TAGLIB_DEPRECATED Header(const ByteVector &data); diff --git a/taglib/mpeg/mpegproperties.h b/taglib/mpeg/mpegproperties.h index a1a1af4a..0b7f0c16 100644 --- a/taglib/mpeg/mpegproperties.h +++ b/taglib/mpeg/mpegproperties.h @@ -65,7 +65,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/ogg/opus/opusproperties.h b/taglib/ogg/opus/opusproperties.h index 2e44dea5..8ec291ea 100644 --- a/taglib/ogg/opus/opusproperties.h +++ b/taglib/ogg/opus/opusproperties.h @@ -67,7 +67,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/ogg/speex/speexproperties.h b/taglib/ogg/speex/speexproperties.h index 3f5a20f3..ad1ba90f 100644 --- a/taglib/ogg/speex/speexproperties.h +++ b/taglib/ogg/speex/speexproperties.h @@ -67,7 +67,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/ogg/vorbis/vorbisproperties.h b/taglib/ogg/vorbis/vorbisproperties.h index 472e0390..b1cd5f0a 100644 --- a/taglib/ogg/vorbis/vorbisproperties.h +++ b/taglib/ogg/vorbis/vorbisproperties.h @@ -73,7 +73,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/riff/aiff/aiffproperties.h b/taglib/riff/aiff/aiffproperties.h index dbb4c214..9ebd86ca 100644 --- a/taglib/riff/aiff/aiffproperties.h +++ b/taglib/riff/aiff/aiffproperties.h @@ -50,7 +50,7 @@ namespace TagLib { * Create an instance of AIFF::Properties with the data read from the * ByteVector \a data. * - * \deprecated + * \deprecated Use Properties(File *, ReadStyle). */ TAGLIB_DEPRECATED Properties(const ByteVector &data, ReadStyle style); @@ -71,7 +71,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; @@ -117,7 +117,7 @@ namespace TagLib { * * \note This method is just an alias of bitsPerSample(). * - * \deprecated + * \deprecated Use bitsPerSample(). */ TAGLIB_DEPRECATED int sampleWidth() const; diff --git a/taglib/riff/wav/wavfile.h b/taglib/riff/wav/wavfile.h index bc9ce312..02db890c 100644 --- a/taglib/riff/wav/wavfile.h +++ b/taglib/riff/wav/wavfile.h @@ -160,7 +160,7 @@ namespace TagLib { virtual bool save(); /*! - * \deprecated + * \deprecated Use save(TagTypes, StripTags, ID3v2::Version). */ TAGLIB_DEPRECATED bool save(TagTypes tags, bool stripOthers, int id3v2Version = 4); diff --git a/taglib/riff/wav/wavproperties.h b/taglib/riff/wav/wavproperties.h index 1ca73100..1d9401f5 100644 --- a/taglib/riff/wav/wavproperties.h +++ b/taglib/riff/wav/wavproperties.h @@ -53,7 +53,7 @@ namespace TagLib { * Create an instance of WAV::Properties with the data read from the * ByteVector \a data. * - * \deprecated + * \deprecated Use Properties(File *, ReadStyle). */ TAGLIB_DEPRECATED Properties(const ByteVector &data, ReadStyle style); @@ -61,7 +61,7 @@ namespace TagLib { * Create an instance of WAV::Properties with the data read from the * ByteVector \a data and the length calculated using \a streamLength. * - * \deprecated + * \deprecated Use Properties(File *, ReadStyle). */ TAGLIB_DEPRECATED Properties(const ByteVector &data, unsigned int streamLength, ReadStyle style); @@ -82,7 +82,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; @@ -128,7 +128,7 @@ namespace TagLib { * * \note This method is just an alias of bitsPerSample(). * - * \deprecated + * \deprecated Use bitsPerSample(). */ TAGLIB_DEPRECATED int sampleWidth() const; diff --git a/taglib/toolkit/tbytevector.h b/taglib/toolkit/tbytevector.h index 41373c72..22cf625d 100644 --- a/taglib/toolkit/tbytevector.h +++ b/taglib/toolkit/tbytevector.h @@ -278,7 +278,7 @@ namespace TagLib { * * \see isEmpty() * - * \deprecated + * \deprecated Use isEmpty(), do not differentiate between null and empty. */ // BIC: remove TAGLIB_DEPRECATED bool isNull() const; @@ -592,7 +592,7 @@ namespace TagLib { * \warning Do not modify this variable. It will mess up the internal state * of TagLib. * - * \deprecated + * \deprecated Use ByteVector(). */ // BIC: remove TAGLIB_DEPRECATED static ByteVector null; diff --git a/taglib/toolkit/tfile.h b/taglib/toolkit/tfile.h index bdc4f124..b9ac95ad 100644 --- a/taglib/toolkit/tfile.h +++ b/taglib/toolkit/tfile.h @@ -261,14 +261,14 @@ namespace TagLib { * Returns true if \a file can be opened for reading. If the file does not * exist, this will return false. * - * \deprecated + * \deprecated Use system functions, e.g. access() (_access_s() on Windows). */ TAGLIB_DEPRECATED static bool isReadable(const char *file); /*! * Returns true if \a file can be opened for writing. * - * \deprecated + * \deprecated Use system functions, e.g. access() (_access_s() on Windows). */ TAGLIB_DEPRECATED static bool isWritable(const char *name); diff --git a/taglib/toolkit/tstring.h b/taglib/toolkit/tstring.h index 7028aab2..e6bbbe7b 100644 --- a/taglib/toolkit/tstring.h +++ b/taglib/toolkit/tstring.h @@ -337,7 +337,7 @@ namespace TagLib { * * \see isEmpty() * - * \deprecated + * \deprecated Use isEmpty(), do not differentiate between null and empty. */ // BIC: remove TAGLIB_DEPRECATED bool isNull() const; @@ -522,7 +522,7 @@ namespace TagLib { * \warning Do not modify this variable. It will mess up the internal state * of TagLib. * - * \deprecated + * \deprecated Use String(). */ // BIC: remove TAGLIB_DEPRECATED static String null; diff --git a/taglib/trueaudio/trueaudiofile.h b/taglib/trueaudio/trueaudiofile.h index 1f664d25..0f883c86 100644 --- a/taglib/trueaudio/trueaudiofile.h +++ b/taglib/trueaudio/trueaudiofile.h @@ -164,7 +164,7 @@ namespace TagLib { * Set the ID3v2::FrameFactory to something other than the default. * * \see ID3v2FrameFactory - * \deprecated This value should be passed in via the constructor + * \deprecated This value should be passed in via the constructor. */ TAGLIB_DEPRECATED void setID3v2FrameFactory(const ID3v2::FrameFactory *factory); diff --git a/taglib/trueaudio/trueaudioproperties.h b/taglib/trueaudio/trueaudioproperties.h index d25c7a77..bfef2bbe 100644 --- a/taglib/trueaudio/trueaudioproperties.h +++ b/taglib/trueaudio/trueaudioproperties.h @@ -67,7 +67,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const; diff --git a/taglib/wavpack/wavpackproperties.h b/taglib/wavpack/wavpackproperties.h index e6acdcc3..fee714d0 100644 --- a/taglib/wavpack/wavpackproperties.h +++ b/taglib/wavpack/wavpackproperties.h @@ -77,7 +77,7 @@ namespace TagLib { * * \note This method is just an alias of lengthInSeconds(). * - * \deprecated + * \deprecated Use lengthInSeconds(). */ TAGLIB_DEPRECATED virtual int length() const;