From fb0f7dfa575caad4b71500cb786dca2ca29c569d Mon Sep 17 00:00:00 2001 From: Urs Fleisch Date: Sat, 6 Jan 2024 12:12:56 +0100 Subject: [PATCH] More API documentation corrections --- bindings/c/tag_c.h | 4 ++-- taglib/ape/apefile.h | 2 +- taglib/ape/apefooter.h | 2 +- taglib/ape/apeproperties.h | 2 +- taglib/asf/asfattribute.h | 2 +- taglib/asf/asfpicture.h | 6 +++--- taglib/asf/asfproperties.h | 2 +- taglib/asf/asftag.h | 4 ++-- taglib/audioproperties.h | 2 +- taglib/dsdiff/dsdifffile.h | 8 ++++---- taglib/dsdiff/dsdiffproperties.h | 2 +- taglib/dsf/dsffile.h | 2 +- taglib/fileref.h | 2 +- taglib/flac/flacfile.h | 4 ++-- taglib/flac/flacproperties.h | 2 +- taglib/it/itfile.h | 6 +++--- taglib/mod/modfile.h | 2 +- taglib/mod/modtag.h | 2 +- taglib/mpc/mpcfile.h | 4 ++-- taglib/mpeg/id3v1/id3v1tag.h | 2 +- taglib/mpeg/id3v2/frames/chapterframe.h | 4 ++-- taglib/mpeg/id3v2/frames/commentsframe.h | 2 +- taglib/mpeg/id3v2/frames/eventtimingcodesframe.h | 2 +- .../id3v2/frames/generalencapsulatedobjectframe.h | 2 +- taglib/mpeg/id3v2/frames/tableofcontentsframe.h | 8 ++++---- taglib/mpeg/id3v2/frames/unsynchronizedlyricsframe.h | 4 ++-- taglib/mpeg/id3v2/frames/urllinkframe.h | 2 +- taglib/mpeg/id3v2/id3v2header.h | 4 ++-- taglib/mpeg/xingheader.h | 2 +- taglib/ogg/flac/oggflacfile.h | 2 +- taglib/ogg/oggfile.h | 2 +- taglib/ogg/oggpage.h | 4 ++-- taglib/ogg/oggpageheader.h | 4 ++-- taglib/ogg/xiphcomment.cpp | 2 +- taglib/ogg/xiphcomment.h | 2 +- taglib/riff/aiff/aifffile.h | 2 +- taglib/riff/rifffile.h | 2 +- taglib/riff/wav/infotag.cpp | 2 +- taglib/riff/wav/infotag.h | 8 ++++---- taglib/riff/wav/wavfile.h | 4 ++-- taglib/riff/wav/wavproperties.h | 2 +- taglib/s3m/s3mfile.h | 2 +- taglib/tag.h | 6 +++--- taglib/toolkit/taglib.h | 6 +++--- taglib/toolkit/tbytevector.h | 12 ++++++------ taglib/toolkit/tdebuglistener.h | 2 +- taglib/toolkit/tfile.h | 2 +- taglib/toolkit/tfilestream.h | 2 +- taglib/toolkit/tlist.h | 4 ++-- taglib/toolkit/tpropertymap.h | 2 +- taglib/toolkit/tstring.cpp | 2 +- taglib/toolkit/tstring.h | 6 +++--- taglib/toolkit/tutils.h | 6 +++--- taglib/toolkit/tvariant.h | 4 ++-- taglib/trueaudio/trueaudiofile.h | 2 +- taglib/trueaudio/trueaudioproperties.h | 2 +- taglib/wavpack/wavpackfile.h | 4 ++-- taglib/wavpack/wavpackproperties.h | 4 ++-- taglib/xm/xmfile.h | 2 +- 59 files changed, 99 insertions(+), 99 deletions(-) diff --git a/bindings/c/tag_c.h b/bindings/c/tag_c.h index 44c855d6..153f8dde 100644 --- a/bindings/c/tag_c.h +++ b/bindings/c/tag_c.h @@ -232,12 +232,12 @@ TAGLIB_C_EXPORT char *taglib_tag_comment(const TagLib_Tag *tag); TAGLIB_C_EXPORT char *taglib_tag_genre(const TagLib_Tag *tag); /*! - * Returns the tag's year or 0 if year is not set. + * Returns the tag's year or 0 if the year is not set. */ TAGLIB_C_EXPORT unsigned int taglib_tag_year(const TagLib_Tag *tag); /*! - * Returns the tag's track number or 0 if track number is not set. + * Returns the tag's track number or 0 if the track number is not set. */ TAGLIB_C_EXPORT unsigned int taglib_tag_track(const TagLib_Tag *tag); diff --git a/taglib/ape/apefile.h b/taglib/ape/apefile.h index 1949bf37..1d1eee6b 100644 --- a/taglib/ape/apefile.h +++ b/taglib/ape/apefile.h @@ -48,7 +48,7 @@ namespace TagLib { //! An implementation of APE metadata /*! - * this is an implementation of APE metadata. + * This is an implementation of APE metadata. * * This supports ID3v1 and APE (v1 and v2) style comments as well as reading stream * properties from the file. diff --git a/taglib/ape/apefooter.h b/taglib/ape/apefooter.h index a516d855..32f5397f 100644 --- a/taglib/ape/apefooter.h +++ b/taglib/ape/apefooter.h @@ -80,7 +80,7 @@ namespace TagLib { bool footerPresent() const; /*! - * Returns \c true this is actually the header. + * Returns \c true if this is actually the header. */ bool isHeader() const; diff --git a/taglib/ape/apeproperties.h b/taglib/ape/apeproperties.h index f61f0e0a..b107d369 100644 --- a/taglib/ape/apeproperties.h +++ b/taglib/ape/apeproperties.h @@ -97,7 +97,7 @@ namespace TagLib { unsigned int sampleFrames() const; /*! - * Returns APE version. + * Returns the APE version. */ int version() const; diff --git a/taglib/asf/asfattribute.h b/taglib/asf/asfattribute.h index 7bb7ba61..93e9e175 100644 --- a/taglib/asf/asfattribute.h +++ b/taglib/asf/asfattribute.h @@ -126,7 +126,7 @@ namespace TagLib virtual ~Attribute(); /*! - * Returns type of the value. + * Returns the type of the value. */ AttributeTypes type() const; diff --git a/taglib/asf/asfpicture.h b/taglib/asf/asfpicture.h index 3703d14d..9fbf8ee8 100644 --- a/taglib/asf/asfpicture.h +++ b/taglib/asf/asfpicture.h @@ -40,9 +40,9 @@ namespace TagLib //! An ASF attached picture interface implementation /*! - * This is an implementation of ASF attached pictures interface. Pictures may be + * This is an implementation of ASF attached pictures. Pictures may be * included in attributes, one per WM/Picture attribute (but there may be multiple WM/Picture - * attribute in a single tag). These pictures are usually in either JPEG or + * attributes in a single tag). These pictures are usually in either JPEG or * PNG format. * \see Attribute::toPicture() * \see Attribute::Attribute(const Picture& picture) @@ -61,7 +61,7 @@ namespace TagLib Picture(); /*! - * Construct an picture as a copy of \a other. + * Construct a picture as a copy of \a other. */ Picture(const Picture& other); diff --git a/taglib/asf/asfproperties.h b/taglib/asf/asfproperties.h index 2440ba3a..a90eba66 100644 --- a/taglib/asf/asfproperties.h +++ b/taglib/asf/asfproperties.h @@ -38,7 +38,7 @@ namespace TagLib { public: /*! - * Audio codec types can be used in ASF file. + * Audio codec types which can be used in ASF files. */ enum Codec { diff --git a/taglib/asf/asftag.h b/taglib/asf/asftag.h index 7ac211ae..752bad2c 100644 --- a/taglib/asf/asftag.h +++ b/taglib/asf/asftag.h @@ -87,8 +87,8 @@ namespace TagLib { virtual String rating() const; /*! - * Returns the genre name; if no genre is present in the tag an empty string - * will be returned. + * Returns the copyright information; if no copyright information is + * present in the tag an empty string will be returned. */ virtual String copyright() const; diff --git a/taglib/audioproperties.h b/taglib/audioproperties.h index 482b9691..021c6329 100644 --- a/taglib/audioproperties.h +++ b/taglib/audioproperties.h @@ -37,7 +37,7 @@ namespace TagLib { /*! * The values here are common to most audio formats. For more specific, codec - * dependent values, please see see the subclasses APIs. This is meant to + * dependent values, please see the subclasses APIs. This is meant to * compliment the TagLib::File and TagLib::Tag APIs in providing a simple * interface that is sufficient for most applications. */ diff --git a/taglib/dsdiff/dsdifffile.h b/taglib/dsdiff/dsdifffile.h index bbfb2e00..9c784a3b 100644 --- a/taglib/dsdiff/dsdifffile.h +++ b/taglib/dsdiff/dsdifffile.h @@ -92,7 +92,7 @@ namespace TagLib { ID3v2::FrameFactory *frameFactory = nullptr); /*! - * Constructs an DSDIFF file from \a stream. If \a readProperties is \c true + * Constructs a DSDIFF file from \a stream. If \a readProperties is \c true * the file's audio properties will also be read. * * If this file contains an ID3v2 tag, the frames will be created using @@ -238,7 +238,7 @@ namespace TagLib { void removeChildChunk(unsigned int i, unsigned int childChunkNum); /*! - * Sets the data for the the specified chunk at root level to \a data. + * Sets the data for the specified chunk at root level to \a data. * * \warning This will update the file immediately. */ @@ -255,7 +255,7 @@ namespace TagLib { void setRootChunkData(const ByteVector &name, const ByteVector &data); /*! - * Sets the data for the the specified child chunk to \a data. + * Sets the data for the specified child chunk to \a data. * * If data is null, then remove the chunk * @@ -267,7 +267,7 @@ namespace TagLib { /*! * Sets the data for the child chunk \a name to \a data. If a chunk with * the given name already exists it will be overwritten, otherwise it will - * be created after the existing chunks inside child chunk. + * be created after the existing chunks inside the child chunk. * * If data is null, then remove the chunks with \a name name * diff --git a/taglib/dsdiff/dsdiffproperties.h b/taglib/dsdiff/dsdiffproperties.h index 6e6ce068..98b21914 100644 --- a/taglib/dsdiff/dsdiffproperties.h +++ b/taglib/dsdiff/dsdiffproperties.h @@ -37,7 +37,7 @@ namespace TagLib { //! An implementation of audio property reading for DSDIFF /*! - * This reads the data from an DSDIFF stream found in the AudioProperties + * This reads the data from a DSDIFF stream found in the AudioProperties * API. */ diff --git a/taglib/dsf/dsffile.h b/taglib/dsf/dsffile.h index 28937695..b538f644 100644 --- a/taglib/dsf/dsffile.h +++ b/taglib/dsf/dsffile.h @@ -40,7 +40,7 @@ namespace TagLib { //! An implementation of DSF metadata /*! - * this is an implementation of DSF metadata using an ID3v2 tag inside the + * This is an implementation of DSF metadata using an ID3v2 tag inside the * metadata chunk. * The DSF specification is located at * http://dsd-guide.com/sites/default/files/white-papers/DSFFileFormatSpec_E.pdf diff --git a/taglib/fileref.h b/taglib/fileref.h index e53eafe6..e4bb0d9a 100644 --- a/taglib/fileref.h +++ b/taglib/fileref.h @@ -222,7 +222,7 @@ namespace TagLib { ~FileRef(); /*! - * Returns a pointer to represented file's tag. + * Returns a pointer to the represented file's tag. * * \warning This pointer will become invalid when this FileRef and all * copies pass out of scope. diff --git a/taglib/flac/flacfile.h b/taglib/flac/flacfile.h index 6ab4762e..4186f222 100644 --- a/taglib/flac/flacfile.h +++ b/taglib/flac/flacfile.h @@ -43,7 +43,7 @@ namespace TagLib { //! An implementation of FLAC metadata /*! - * this is an implementation of FLAC metadata for non-Ogg FLAC files. At some + * This is an implementation of FLAC metadata for non-Ogg FLAC files. At some * point when Ogg / FLAC is more common there will be a similar implementation * under the Ogg hierarchy. * @@ -96,7 +96,7 @@ namespace TagLib { ID3v2::FrameFactory *frameFactory = nullptr); /*! - * Constructs an FLAC file from \a file. If \a readProperties is \c true the + * Constructs a FLAC file from \a file. If \a readProperties is \c true the * file's audio properties will also be read. * * If this file contains an ID3v2 tag, the frames will be created using diff --git a/taglib/flac/flacproperties.h b/taglib/flac/flacproperties.h index 2effd60d..5926a82d 100644 --- a/taglib/flac/flacproperties.h +++ b/taglib/flac/flacproperties.h @@ -37,7 +37,7 @@ namespace TagLib { //! An implementation of audio property reading for FLAC /*! - * This reads the data from an FLAC stream found in the AudioProperties + * This reads the data from a FLAC stream found in the AudioProperties * API. */ diff --git a/taglib/it/itfile.h b/taglib/it/itfile.h index 8ed8e95b..8bc7c7cf 100644 --- a/taglib/it/itfile.h +++ b/taglib/it/itfile.h @@ -34,7 +34,7 @@ namespace TagLib { //! An implementation of Impulse Tracker metadata /*! - * this is an implementation of Impulse Tracker metadata. + * This is an implementation of Impulse Tracker metadata. */ namespace IT { @@ -51,7 +51,7 @@ namespace TagLib { class TAGLIB_EXPORT File : public Mod::FileBase { public: /*! - * Constructs a Impulse Tracker file from \a file. + * Constructs an Impulse Tracker file from \a file. * * \note In the current implementation, both \a readProperties and * \a propertiesStyle are ignored. The audio properties are always @@ -62,7 +62,7 @@ namespace TagLib { AudioProperties::Average); /*! - * Constructs a Impulse Tracker file from \a stream. + * Constructs an Impulse Tracker file from \a stream. * * \note In the current implementation, both \a readProperties and * \a propertiesStyle are ignored. The audio properties are always diff --git a/taglib/mod/modfile.h b/taglib/mod/modfile.h index 8f654c99..73c28527 100644 --- a/taglib/mod/modfile.h +++ b/taglib/mod/modfile.h @@ -38,7 +38,7 @@ namespace TagLib { //! An implementation of Protracker metadata /*! - * this is an implementation of Protracker metadata. + * This is an implementation of Protracker metadata. */ namespace Mod { diff --git a/taglib/mod/modtag.h b/taglib/mod/modtag.h index 53f40faa..336d75ee 100644 --- a/taglib/mod/modtag.h +++ b/taglib/mod/modtag.h @@ -131,7 +131,7 @@ namespace TagLib { * module file is fixed to the number of instruments/patterns/samples. * * Also note that the instrument/pattern/sample name length is limited - * an thus the line length in comments are limited. Too big comments + * and thus the line length in comments are limited. Too big comments * will be truncated. * * The line length limits per file type are (1 character = 1 byte): diff --git a/taglib/mpc/mpcfile.h b/taglib/mpc/mpcfile.h index 76de2bb5..5b9e909a 100644 --- a/taglib/mpc/mpcfile.h +++ b/taglib/mpc/mpcfile.h @@ -42,7 +42,7 @@ namespace TagLib { //! An implementation of MPC metadata /*! - * this is an implementation of MPC metadata. + * This is an implementation of MPC metadata. * * This supports ID3v1 and APE (v1 and v2) style comments as well as reading stream * properties from the file. ID3v2 tags are invalid in MPC-files, but will be skipped @@ -170,7 +170,7 @@ namespace TagLib { * If \a create is \c false (the default) this may return a null pointer * if there is no valid APE tag. If \a create is \c true it will create * an APE tag if one does not exist and returns a valid pointer. If - * there already be an ID3v1 tag, the new APE tag will be placed before it. + * there already is an ID3v1 tag, the new APE tag will be placed before it. * * \note This may return a valid pointer regardless of whether or not the * file on disk has an APE tag. Use hasAPETag() to check if the file diff --git a/taglib/mpeg/id3v1/id3v1tag.h b/taglib/mpeg/id3v1/id3v1tag.h index 469061f1..e3fd4dd3 100644 --- a/taglib/mpeg/id3v1/id3v1tag.h +++ b/taglib/mpeg/id3v1/id3v1tag.h @@ -196,7 +196,7 @@ namespace TagLib { */ void read(); /*! - * Pareses the body of the tag in \a data. + * Parses the body of the tag in \a data. */ void parse(const ByteVector &data); diff --git a/taglib/mpeg/id3v2/frames/chapterframe.h b/taglib/mpeg/id3v2/frames/chapterframe.h index 62cb13a5..27a42f7d 100644 --- a/taglib/mpeg/id3v2/frames/chapterframe.h +++ b/taglib/mpeg/id3v2/frames/chapterframe.h @@ -100,7 +100,7 @@ namespace TagLib { * Returns zero based byte offset (count of bytes from the beginning * of the audio file) of chapter's start. * - * \note If returned value is 0xFFFFFFFF, start time should be used instead. + * \note If the returned value is 0xFFFFFFFF, start time should be used instead. * \see setStartOffset() */ unsigned int startOffset() const; @@ -109,7 +109,7 @@ namespace TagLib { * Returns zero based byte offset (count of bytes from the beginning * of the audio file) of chapter's end. * - * \note If returned value is 0xFFFFFFFF, end time should be used instead. + * \note If the returned value is 0xFFFFFFFF, end time should be used instead. * \see setEndOffset() */ unsigned int endOffset() const; diff --git a/taglib/mpeg/id3v2/frames/commentsframe.h b/taglib/mpeg/id3v2/frames/commentsframe.h index 0c341228..aaee6ae4 100644 --- a/taglib/mpeg/id3v2/frames/commentsframe.h +++ b/taglib/mpeg/id3v2/frames/commentsframe.h @@ -153,7 +153,7 @@ namespace TagLib { /*! * Comments each have a unique description. This searches for a comment * frame with the description \a d and returns a pointer to it. If no - * frame is found that matches the given description null is returned. + * frame is found that matches the given description, null is returned. * * \see description() */ diff --git a/taglib/mpeg/id3v2/frames/eventtimingcodesframe.h b/taglib/mpeg/id3v2/frames/eventtimingcodesframe.h index f70976af..2e6678a3 100644 --- a/taglib/mpeg/id3v2/frames/eventtimingcodesframe.h +++ b/taglib/mpeg/id3v2/frames/eventtimingcodesframe.h @@ -124,7 +124,7 @@ namespace TagLib { explicit EventTimingCodesFrame(); /*! - * Construct a event timing codes frame based on the data in \a data. + * Construct an event timing codes frame based on the data in \a data. */ explicit EventTimingCodesFrame(const ByteVector &data); diff --git a/taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h b/taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h index d4562dea..b4dc4130 100644 --- a/taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h +++ b/taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h @@ -42,7 +42,7 @@ namespace TagLib { /*! * This is an implementation of ID3v2 general encapsulated objects. * Arbitrary binary data may be included in tags, stored in GEOB frames. - * There may be multiple GEOB frames in a single tag. Each GEOB it + * There may be multiple GEOB frames in a single tag. Each GEOB is * labelled with a content description (which may be blank), a required * mime-type, and a file name (may be blank). The content description * uniquely identifies the GEOB frame in the tag. diff --git a/taglib/mpeg/id3v2/frames/tableofcontentsframe.h b/taglib/mpeg/id3v2/frames/tableofcontentsframe.h index 1e457f23..06effb7b 100644 --- a/taglib/mpeg/id3v2/frames/tableofcontentsframe.h +++ b/taglib/mpeg/id3v2/frames/tableofcontentsframe.h @@ -94,8 +94,8 @@ namespace TagLib { bool isOrdered() const; /*! - * Returns count of child elements of the frame. It always - * corresponds to size of child elements list. + * Returns the count of child elements of the frame. It always + * corresponds to the size of the child elements list. * * \see childElements() */ @@ -139,7 +139,7 @@ namespace TagLib { void setChildElements(const ByteVectorList &l); /*! - * Adds \a cE to list of child elements of the frame. + * Adds \a cE to the list of child elements of the frame. * * \see childElements() */ @@ -237,7 +237,7 @@ namespace TagLib { /*! * CTOC frames each contain a flag that indicates, if CTOC frame is top-level (there isn't * any frame, which contains this frame in its child elements list). Only a single frame - * within tag can be top-level. This searches for a top-level CTOC frame. + * within the tag can be top-level. This searches for a top-level CTOC frame. * * \see isTopLevel() */ diff --git a/taglib/mpeg/id3v2/frames/unsynchronizedlyricsframe.h b/taglib/mpeg/id3v2/frames/unsynchronizedlyricsframe.h index c71a788f..056893d2 100644 --- a/taglib/mpeg/id3v2/frames/unsynchronizedlyricsframe.h +++ b/taglib/mpeg/id3v2/frames/unsynchronizedlyricsframe.h @@ -50,7 +50,7 @@ namespace TagLib { explicit UnsynchronizedLyricsFrame(String::Type encoding = String::Latin1); /*! - * Construct a unsynchronized lyrics frame based on the data in \a data. + * Construct an unsynchronized lyrics frame based on the data in \a data. */ explicit UnsynchronizedLyricsFrame(const ByteVector &data); @@ -153,7 +153,7 @@ namespace TagLib { /*! * LyricsFrames each have a unique description. This searches for a lyrics * frame with the description \a d and returns a pointer to it. If no - * frame is found that matches the given description null is returned. + * frame is found that matches the given description, null is returned. * * \see description() */ diff --git a/taglib/mpeg/id3v2/frames/urllinkframe.h b/taglib/mpeg/id3v2/frames/urllinkframe.h index 2b10ae45..afca6cc9 100644 --- a/taglib/mpeg/id3v2/frames/urllinkframe.h +++ b/taglib/mpeg/id3v2/frames/urllinkframe.h @@ -158,7 +158,7 @@ namespace TagLib { /*! * Parses the UserUrlLinkFrame as PropertyMap. The description() is taken as key, - * and the URL as single value. + * and the URL as a single value. * - if description() is empty, the key will be "URL". * - otherwise, if description() is not a valid key (e.g. containing non-ASCII * characters), the returned map will contain an entry "WXXX/" diff --git a/taglib/mpeg/id3v2/id3v2header.h b/taglib/mpeg/id3v2/id3v2header.h index 53a22ee7..1d082ad1 100644 --- a/taglib/mpeg/id3v2/id3v2header.h +++ b/taglib/mpeg/id3v2/id3v2header.h @@ -75,7 +75,7 @@ namespace TagLib { unsigned int majorVersion() const; /*! - * Set the the major version number to \a version. (Note: This is + * Set the major version number to \a version. (Note: This is * the 4, not the 2 in ID3v2.4.0. The 2 is implied.) * \see majorVersion() * @@ -143,7 +143,7 @@ namespace TagLib { static unsigned int size(); /*! - * Returns the string used to identify and ID3v2 tag inside of a file. + * Returns the string used to identify an ID3v2 tag inside of a file. * Presently this is always "ID3". */ static ByteVector fileIdentifier(); diff --git a/taglib/mpeg/xingheader.h b/taglib/mpeg/xingheader.h index 88128d00..6c7f5a19 100644 --- a/taglib/mpeg/xingheader.h +++ b/taglib/mpeg/xingheader.h @@ -74,7 +74,7 @@ namespace TagLib { }; /*! - * Parses an Xing/VBRI header based on \a data which contains the entire + * Parses a Xing/VBRI header based on \a data which contains the entire * first MPEG frame. */ XingHeader(const ByteVector &data); diff --git a/taglib/ogg/flac/oggflacfile.h b/taglib/ogg/flac/oggflacfile.h index 0ca26875..d83be0b3 100644 --- a/taglib/ogg/flac/oggflacfile.h +++ b/taglib/ogg/flac/oggflacfile.h @@ -40,7 +40,7 @@ namespace TagLib { //! An implementation of Ogg FLAC metadata /*! - * this is an implementation of FLAC metadata for Ogg FLAC files. For "pure" + * This is an implementation of FLAC metadata for Ogg FLAC files. For "pure" * FLAC files look under the FLAC hierarchy. * * Unlike "pure" FLAC-files, Ogg FLAC only supports Xiph-comments, diff --git a/taglib/ogg/oggfile.h b/taglib/ogg/oggfile.h index eed0edba..7389e290 100644 --- a/taglib/ogg/oggfile.h +++ b/taglib/ogg/oggfile.h @@ -44,7 +44,7 @@ namespace TagLib { * This is an implementation of Ogg file page and packet rendering and is of * use to Ogg based formats. While the API is small this handles the * non-trivial details of breaking up an Ogg stream into packets and makes - * these available (via subclassing) to the codec meta data implementations. + * these available (via subclassing) to the codec metadata implementations. */ class TAGLIB_EXPORT File : public TagLib::File diff --git a/taglib/ogg/oggpage.h b/taglib/ogg/oggpage.h index f0696836..26bad56e 100644 --- a/taglib/ogg/oggpage.h +++ b/taglib/ogg/oggpage.h @@ -46,7 +46,7 @@ namespace TagLib { * * In most Xiph.org formats the comments are found in the first few packets, * this however is a reasonably complete implementation of Ogg pages that - * could potentially be useful for non-meta data purposes. + * could potentially be useful for non-metadata purposes. */ class TAGLIB_EXPORT Page @@ -105,7 +105,7 @@ namespace TagLib { /*! * When checking to see if a page contains a given packet this set of flags - * represents the possible values for that packets status in the page. + * represents the possible values for that packet's status in the page. * * \see containsPacket() */ diff --git a/taglib/ogg/oggpageheader.h b/taglib/ogg/oggpageheader.h index 6b61196d..52c8a889 100644 --- a/taglib/ogg/oggpageheader.h +++ b/taglib/ogg/oggpageheader.h @@ -69,7 +69,7 @@ namespace TagLib { /*! * Ogg pages contain a list of packets (which are used by the contained - * codecs). The sizes of these pages is encoded in the page header. This + * codecs). The sizes of these pages are encoded in the page header. This * returns a list of the packet sizes in bytes. * * \see setPacketSizes() @@ -87,7 +87,7 @@ namespace TagLib { /*! * Some packets can be continued across multiple pages. If the * first packet in the current page is a continuation this will return - * \c true. If this is page starts with a new packet this will return \c false. + * \c true. If this page starts with a new packet this will return \c false. * * \see lastPacketCompleted() * \see setFirstPacketContinued() diff --git a/taglib/ogg/xiphcomment.cpp b/taglib/ogg/xiphcomment.cpp index 3769057d..6b1109ad 100644 --- a/taglib/ogg/xiphcomment.cpp +++ b/taglib/ogg/xiphcomment.cpp @@ -215,7 +215,7 @@ PropertyMap Ogg::XiphComment::setProperties(const PropertyMap &properties) for(const auto &field : std::as_const(toRemove)) removeFields(field); - // now go through keys in \a properties and check that the values match those in the xiph comment + // now go through keys in \a properties and check that the values match those in the Xiph comment PropertyMap invalid; for(const auto &[key, sl] : properties) { if(!checkKey(key)) diff --git a/taglib/ogg/xiphcomment.h b/taglib/ogg/xiphcomment.h index 13becb5d..b6b8d394 100644 --- a/taglib/ogg/xiphcomment.h +++ b/taglib/ogg/xiphcomment.h @@ -235,7 +235,7 @@ namespace TagLib { List pictureList(); /*! - * Removes an picture. If \a del is \c true the picture's memory + * Removes a picture. If \a del is \c true the picture's memory * will be freed; if it is \c false, it must be deleted by the user. */ void removePicture(FLAC::Picture *picture, bool del = true); diff --git a/taglib/riff/aiff/aifffile.h b/taglib/riff/aiff/aifffile.h index 4619ae5c..d50cf04e 100644 --- a/taglib/riff/aiff/aifffile.h +++ b/taglib/riff/aiff/aifffile.h @@ -37,7 +37,7 @@ namespace TagLib { //! An implementation of AIFF metadata /*! - * this is an implementation of AIFF metadata. + * This is an implementation of AIFF metadata. * * This supports an ID3v2 tag as well as reading stream from the ID3 RIFF * chunk as well as properties from the file. diff --git a/taglib/riff/rifffile.h b/taglib/riff/rifffile.h index 3dd4cf56..75fcc5af 100644 --- a/taglib/riff/rifffile.h +++ b/taglib/riff/rifffile.h @@ -35,7 +35,7 @@ namespace TagLib { namespace RIFF { - //! An RIFF file class with some useful methods specific to RIFF + //! A RIFF file class with some useful methods specific to RIFF /*! * This implements the generic TagLib::File API and additionally provides diff --git a/taglib/riff/wav/infotag.cpp b/taglib/riff/wav/infotag.cpp index 1db493c9..ac9fed8b 100644 --- a/taglib/riff/wav/infotag.cpp +++ b/taglib/riff/wav/infotag.cpp @@ -260,7 +260,7 @@ String RIFF::Info::Tag::fieldText(const ByteVector &id) const void RIFF::Info::Tag::setFieldText(const ByteVector &id, const String &s) { - // id must be four-byte long pure ascii string. + // id must be a four-byte long pure ascii string. if(!isValidChunkName(id)) return; diff --git a/taglib/riff/wav/infotag.h b/taglib/riff/wav/infotag.h index 95b0451e..14f8c679 100644 --- a/taglib/riff/wav/infotag.h +++ b/taglib/riff/wav/infotag.h @@ -102,7 +102,7 @@ namespace TagLib { Tag(); /*! - * Constructs an INFO tag read from \a data which is contents of "LIST" chunk. + * Constructs an INFO tag read from \a data which is the contents of the "LIST" chunk. */ Tag(const ByteVector &data); @@ -157,7 +157,7 @@ namespace TagLib { * If the field does not exist, it is created. * If \a s is empty, the field is removed. * - * \note fieldId must be four-byte long pure ASCII string. This function + * \note fieldId must be a four-byte long pure ASCII string. This function * performs nothing if fieldId is invalid. */ void setFieldText(const ByteVector &id, const String &s); @@ -170,7 +170,7 @@ namespace TagLib { /*! * Render the tag back to binary data, suitable to be written to disk. * - * \note Returns empty ByteVector is the tag contains no fields. + * \note Returns an empty ByteVector if the tag contains no fields. */ ByteVector render() const; @@ -189,7 +189,7 @@ namespace TagLib { protected: /*! - * Pareses the body of the tag in \a data. + * Parses the body of the tag in \a data. */ void parse(const ByteVector &data); diff --git a/taglib/riff/wav/wavfile.h b/taglib/riff/wav/wavfile.h index b457563a..32330e51 100644 --- a/taglib/riff/wav/wavfile.h +++ b/taglib/riff/wav/wavfile.h @@ -38,7 +38,7 @@ namespace TagLib { //! An implementation of WAV metadata /*! - * this is an implementation of WAV metadata. + * This is an implementation of WAV metadata. * * This supports an ID3v2 tag as well as reading stream from the ID3 RIFF * chunk as well as properties from the file. @@ -107,7 +107,7 @@ namespace TagLib { File &operator=(const File &) = delete; /*! - * Returns the tag for this file. This will be an RIFF INFO tag, an + * Returns the tag for this file. This will be a RIFF INFO tag, an * ID3v2 tag or a combination of the two. */ TagLib::Tag *tag() const override; diff --git a/taglib/riff/wav/wavproperties.h b/taglib/riff/wav/wavproperties.h index 21a8c6e6..41dc825c 100644 --- a/taglib/riff/wav/wavproperties.h +++ b/taglib/riff/wav/wavproperties.h @@ -42,7 +42,7 @@ namespace TagLib { //! An implementation of audio property reading for WAV /*! - * This reads the data from an WAV stream found in the AudioProperties + * This reads the data from a WAV stream found in the AudioProperties * API. */ diff --git a/taglib/s3m/s3mfile.h b/taglib/s3m/s3mfile.h index f50bc0f9..9095d2f6 100644 --- a/taglib/s3m/s3mfile.h +++ b/taglib/s3m/s3mfile.h @@ -38,7 +38,7 @@ namespace TagLib { //! An implementation of ScreamTracker III metadata /*! - * this is an implementation of ScreamTracker III metadata. + * This is an implementation of ScreamTracker III metadata. */ namespace S3M { diff --git a/taglib/tag.h b/taglib/tag.h index ed9a53ed..cfd15917 100644 --- a/taglib/tag.h +++ b/taglib/tag.h @@ -35,10 +35,10 @@ namespace TagLib { class PropertyMap; - //! A simple, generic interface to common audio meta data fields. + //! A simple, generic interface to common audio metadata fields. /*! - * This is an attempt to abstract away the difference in the meta data formats + * This is an attempt to abstract away the difference in the metadata formats * of various audio codecs and tagging schemes. As such it is generally a * subset of what is available in the specific formats but should be suitable * for most applications. This is meant to compliment the generic APIs found @@ -217,7 +217,7 @@ namespace TagLib { /*! * Copies the generic data from one tag to another. * - * \note This will no affect any of the lower level details of the tag. For + * \note This will not affect any of the lower level details of the tag. For * instance if any of the tag type specific data (maybe a URL for a band) is * set, this will not modify or copy that. This just copies using the API * in this class. diff --git a/taglib/toolkit/taglib.h b/taglib/toolkit/taglib.h index a53a871a..7f012b9d 100644 --- a/taglib/toolkit/taglib.h +++ b/taglib/toolkit/taglib.h @@ -89,10 +89,10 @@ namespace TagLib { * * \section intro Introduction * - * TagLib is a library for reading and editing audio meta data, commonly known as \e tags. + * TagLib is a library for reading and editing audio metadata, commonly known as \e tags. * * Features: - * - A clean, high level, C++ API to handling audio meta data. + * - A clean, high level, C++ API for handling audio metadata. * - Format specific APIs for advanced API users. * - ID3v1, ID3v2, APE, FLAC, Xiph, iTunes-style MP4 and WMA tag formats. * - MP3, MPC, FLAC, MP4, ASF, AIFF, WAV, DSF, DFF, TrueAudio, WavPack, Ogg FLAC, Ogg Vorbis, Speex and Opus file formats. @@ -114,7 +114,7 @@ namespace TagLib { * * \section commercial Usage in Commercial Applications * - * TagLib's licenses \e do allow usage within propriety (\e closed) applications, however TagLib is \e not + * TagLib's licenses \e do allow usage within proprietary (\e closed) applications, however TagLib is \e not * public domain. Please note the requirements of the LGPL or MPL, and adhere to at least one of them. * In simple terms, you must at a minimum note your usage of TagLib, note the licensing terms of TagLib and * if you make changes to TagLib publish them. Please review the licenses above before using TagLib in your diff --git a/taglib/toolkit/tbytevector.h b/taglib/toolkit/tbytevector.h index 4a5b790c..fdb0eeae 100644 --- a/taglib/toolkit/tbytevector.h +++ b/taglib/toolkit/tbytevector.h @@ -454,7 +454,7 @@ namespace TagLib { * Converts the 10 bytes at \a offset of the vector to a long double as an * IEEE754 80-bit little-endian floating point number. * - * \note This may compromise the precision depends on the size of long double. + * \note This may compromise the precision depending on the size of long double. */ long double toFloat80LE(size_t offset) const; @@ -462,7 +462,7 @@ namespace TagLib { * Converts the 10 bytes at \a offset of the vector to a long double as an * IEEE754 80-bit big-endian floating point number. * - * \note This may compromise the precision depends on the size of long double. + * \note This may compromise the precision depending on the size of long double. */ long double toFloat80BE(size_t offset) const; @@ -498,7 +498,7 @@ namespace TagLib { static ByteVector fromUShort(unsigned short value, bool mostSignificantByteFirst = true); /*! - * Creates a 8 byte ByteVector based on \a value. If + * Creates an 8 byte ByteVector based on \a value. If * \a mostSignificantByteFirst is \c true, then this will operate left to right * in building the ByteVector. For example if \a mostSignificantByteFirst is * \c true then $00 00 00 01 == 0x0000000000000001 == 1, if \c false, @@ -509,7 +509,7 @@ namespace TagLib { static ByteVector fromLongLong(long long value, bool mostSignificantByteFirst = true); /*! - * Creates a 8 byte ByteVector based on \a value. If + * Creates an 8 byte ByteVector based on \a value. If * \a mostSignificantByteFirst is \c true, then this will operate left to right * in building the ByteVector. For example if \a mostSignificantByteFirst is * \c true then $00 00 00 01 == 0x0000000000000001 == 1, if \c false, @@ -536,7 +536,7 @@ namespace TagLib { static ByteVector fromFloat32BE(float value); /*! - * Creates a 8 byte ByteVector based on \a value as an IEEE754 64-bit + * Creates an 8 byte ByteVector based on \a value as an IEEE754 64-bit * little-endian floating point number. * * \see toFloat64LE() @@ -544,7 +544,7 @@ namespace TagLib { static ByteVector fromFloat64LE(double value); /*! - * Creates a 8 byte ByteVector based on \a value as an IEEE754 64-bit + * Creates an 8 byte ByteVector based on \a value as an IEEE754 64-bit * big-endian floating point number. * * \see toFloat64BE() diff --git a/taglib/toolkit/tdebuglistener.h b/taglib/toolkit/tdebuglistener.h index 52f30e68..5a8aed78 100644 --- a/taglib/toolkit/tdebuglistener.h +++ b/taglib/toolkit/tdebuglistener.h @@ -63,7 +63,7 @@ namespace TagLib /*! * Sets the listener that decides how the debug messages are redirected. * If the parameter \a listener is null, the previous listener is released - * and default stderr listener is restored. + * and the default stderr listener is restored. * * \note The caller is responsible for deleting the previous listener * as needed after it is released. diff --git a/taglib/toolkit/tfile.h b/taglib/toolkit/tfile.h index 5752a82e..6d4eadb3 100644 --- a/taglib/toolkit/tfile.h +++ b/taglib/toolkit/tfile.h @@ -281,7 +281,7 @@ namespace TagLib { protected: /*! - * Construct a File object and opens the \a file. \a file should be a + * Construct a File object and open the \a file. \a file should be a * C-string in the local file system encoding. * * \note Constructor is protected since this class should only be diff --git a/taglib/toolkit/tfilestream.h b/taglib/toolkit/tfilestream.h index 3eec5630..e3d8d2ca 100644 --- a/taglib/toolkit/tfilestream.h +++ b/taglib/toolkit/tfilestream.h @@ -43,7 +43,7 @@ namespace TagLib { { public: /*! - * Construct a FileStream object and opens the \a file. \a file should be a + * Construct a FileStream object and open the \a file. \a file should be a * C-string in the local file system encoding. */ FileStream(FileName file, bool openReadOnly = false); diff --git a/taglib/toolkit/tlist.h b/taglib/toolkit/tlist.h index 9e070710..0b91fadc 100644 --- a/taglib/toolkit/tlist.h +++ b/taglib/toolkit/tlist.h @@ -79,7 +79,7 @@ namespace TagLib { /*! * Destroys this List instance. If auto deletion is enabled and this list - * contains a pointer type all of the members are also deleted. + * contains a pointer type, all of the members are also deleted. */ ~List(); @@ -241,7 +241,7 @@ namespace TagLib { void setAutoDelete(bool autoDelete); /*! - * Returns \c true is auto-deletion is enabled. + * Returns \c true if auto-deletion is enabled. */ bool autoDelete() const; diff --git a/taglib/toolkit/tpropertymap.h b/taglib/toolkit/tpropertymap.h index 0cc4486b..194daa82 100644 --- a/taglib/toolkit/tpropertymap.h +++ b/taglib/toolkit/tpropertymap.h @@ -182,7 +182,7 @@ namespace TagLib { /*! * Returns \c true if this map contains all keys of \a other - * and the values coincide for that keys. Does not take + * and the values coincide for those keys. Does not take * the unsupportedData list into account. */ TAGLIB_EXPORT diff --git a/taglib/toolkit/tstring.cpp b/taglib/toolkit/tstring.cpp index 493a1dcd..b965f1d5 100644 --- a/taglib/toolkit/tstring.cpp +++ b/taglib/toolkit/tstring.cpp @@ -143,7 +143,7 @@ namespace TagLib { TagLib::wstring data; /*! - * This is only used to hold the the most recent value of toCString(). + * This is only used to hold the most recent value of toCString(). */ std::string cstring; }; diff --git a/taglib/toolkit/tstring.h b/taglib/toolkit/tstring.h index 070013c2..8da380ee 100644 --- a/taglib/toolkit/tstring.h +++ b/taglib/toolkit/tstring.h @@ -97,7 +97,7 @@ namespace TagLib { */ enum Type { /*! - * IS08859-1, or Latin1 encoding. 8 bit characters. + * ISO-8859-1, or Latin1 encoding. 8 bit characters. */ Latin1 = 0, /*! @@ -199,7 +199,7 @@ namespace TagLib { std::string to8Bit(bool unicode = false) const; /*! - * Returns a deep copy of this String as a wstring. The returned string is + * Returns a deep copy of this String as a \c wstring. The returned string is * encoded in UTF-16 (without BOM/CPU byte order), not UTF-32 even if \c wchar_t * is 32-bit wide. * @@ -297,7 +297,7 @@ namespace TagLib { StringList split(const String &separator = " ") const; /*! - * Returns \c true if the strings starts with the substring \a s. + * Returns \c true if the string starts with the substring \a s. */ bool startsWith(const String &s) const; diff --git a/taglib/toolkit/tutils.h b/taglib/toolkit/tutils.h index ee60d386..f974c2c9 100644 --- a/taglib/toolkit/tutils.h +++ b/taglib/toolkit/tutils.h @@ -58,7 +58,7 @@ namespace TagLib { /*! - * Reverses the order of bytes in an 16-bit integer. + * Reverses the order of bytes in a 16-bit integer. */ inline unsigned short byteSwap(unsigned short x) { @@ -90,7 +90,7 @@ namespace TagLib } /*! - * Reverses the order of bytes in an 32-bit integer. + * Reverses the order of bytes in a 32-bit integer. */ inline unsigned int byteSwap(unsigned int x) { @@ -125,7 +125,7 @@ namespace TagLib } /*! - * Reverses the order of bytes in an 64-bit integer. + * Reverses the order of bytes in a 64-bit integer. */ inline unsigned long long byteSwap(unsigned long long x) { diff --git a/taglib/toolkit/tvariant.h b/taglib/toolkit/tvariant.h index f814fc0f..dcbc6138 100644 --- a/taglib/toolkit/tvariant.h +++ b/taglib/toolkit/tvariant.h @@ -166,13 +166,13 @@ namespace TagLib { T value(bool *ok = nullptr) const; /*! - * Returns \c true it the Variant and \a v are of the same type and contain the + * Returns \c true if the Variant and \a v are of the same type and contain the * same value. */ bool operator==(const Variant &v) const; /*! - * Returns \c true it the Variant and \a v differ in type or value. + * Returns \c true if the Variant and \a v differ in type or value. */ bool operator!=(const Variant &v) const; diff --git a/taglib/trueaudio/trueaudiofile.h b/taglib/trueaudio/trueaudiofile.h index 62b3685c..ddc19174 100644 --- a/taglib/trueaudio/trueaudiofile.h +++ b/taglib/trueaudio/trueaudiofile.h @@ -44,7 +44,7 @@ namespace TagLib { //! An implementation of TrueAudio metadata /*! - * this is an implementation of TrueAudio metadata. + * This is an implementation of TrueAudio metadata. * * This supports ID3v1 and ID3v2 tags as well as reading stream * properties from the file. diff --git a/taglib/trueaudio/trueaudioproperties.h b/taglib/trueaudio/trueaudioproperties.h index 31c6de46..ba98518f 100644 --- a/taglib/trueaudio/trueaudioproperties.h +++ b/taglib/trueaudio/trueaudioproperties.h @@ -42,7 +42,7 @@ namespace TagLib { //! An implementation of audio property reading for TrueAudio /*! - * This reads the data from an TrueAudio stream found in the AudioProperties + * This reads the data from a TrueAudio stream found in the AudioProperties * API. */ diff --git a/taglib/wavpack/wavpackfile.h b/taglib/wavpack/wavpackfile.h index c9e82e6b..0b33a647 100644 --- a/taglib/wavpack/wavpackfile.h +++ b/taglib/wavpack/wavpackfile.h @@ -44,7 +44,7 @@ namespace TagLib { //! An implementation of WavPack metadata /*! - * this is an implementation of WavPack metadata. + * This is an implementation of WavPack metadata. * * This supports ID3v1 and APE (v1 and v2) style comments as well as reading stream * properties from the file. @@ -88,7 +88,7 @@ namespace TagLib { Properties::ReadStyle propertiesStyle = Properties::Average); /*! - * Constructs an WavPack file from \a file. If \a readProperties is \c true the + * Constructs a WavPack file from \a file. If \a readProperties is \c true the * file's audio properties will also be read using \a propertiesStyle. If * \c false, \a propertiesStyle is ignored. * diff --git a/taglib/wavpack/wavpackproperties.h b/taglib/wavpack/wavpackproperties.h index 2319ff2a..7d03ee43 100644 --- a/taglib/wavpack/wavpackproperties.h +++ b/taglib/wavpack/wavpackproperties.h @@ -45,7 +45,7 @@ namespace TagLib { //! An implementation of audio property reading for WavPack /*! - * This reads the data from an WavPack stream found in the AudioProperties + * This reads the data from a WavPack stream found in the AudioProperties * API. */ @@ -103,7 +103,7 @@ namespace TagLib { unsigned int sampleFrames() const; /*! - * Returns WavPack version. + * Returns the WavPack version. */ int version() const; diff --git a/taglib/xm/xmfile.h b/taglib/xm/xmfile.h index b0cd55e2..17cf07a3 100644 --- a/taglib/xm/xmfile.h +++ b/taglib/xm/xmfile.h @@ -38,7 +38,7 @@ namespace TagLib { //! An implementation of Extended Module metadata /*! - * this is an implementation of Extended Module metadata. + * This is an implementation of Extended Module metadata. */ namespace XM {