mirror/taglib
1
0
Fork 0
mirror of https://github.com/taglib/taglib.git synced 2025-05-27 21:20:26 -04:00
Code Issues Packages Projects Releases Wiki Activity

More API documentation corrections

Browse Source
This commit is contained in:
Urs Fleisch 2024-01-06 12:12:56 +01:00
parent c5d798a50d
commit fb0f7dfa57
59 changed files with 99 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
bindings/c/tag_c.h
View File

@ -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);

2
taglib/ape/apefile.h
View File

@ -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.

2
taglib/ape/apefooter.h
View File

@ -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;

2
taglib/ape/apeproperties.h
View File

@ -97,7 +97,7 @@ namespace TagLib {
unsigned int sampleFrames() const;
/*!
* Returns APE version.
* Returns the APE version.
*/
int version() const;

2
taglib/asf/asfattribute.h
View File

@ -126,7 +126,7 @@ namespace TagLib
virtual ~Attribute();
/*!
* Returns type of the value.
* Returns the type of the value.
*/
AttributeTypes type() const;

6
taglib/asf/asfpicture.h
View File

@ -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);

2
taglib/asf/asfproperties.h
View File

@ -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
{

4
taglib/asf/asftag.h
View File

@ -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;

2
taglib/audioproperties.h
View File

@ -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.
*/

8
taglib/dsdiff/dsdifffile.h
View File

@ -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
*

2
taglib/dsdiff/dsdiffproperties.h
View File

@ -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.
*/

2
taglib/dsf/dsffile.h
View File

@ -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

2
taglib/fileref.h
View File

@ -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.

4
taglib/flac/flacfile.h
View File

@ -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

2
taglib/flac/flacproperties.h
View File

@ -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.
*/

6
taglib/it/itfile.h
View File

@ -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

2
taglib/mod/modfile.h
View File

@ -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 {

2
taglib/mod/modtag.h
View File

@ -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):

4
taglib/mpc/mpcfile.h
View File

@ -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

2
taglib/mpeg/id3v1/id3v1tag.h
View File

@ -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);

4
taglib/mpeg/id3v2/frames/chapterframe.h
View File

@ -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;

2
taglib/mpeg/id3v2/frames/commentsframe.h
View File

@ -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()
*/

2
taglib/mpeg/id3v2/frames/eventtimingcodesframe.h
View File

@ -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);

2
taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h
View File

@ -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.

8
taglib/mpeg/id3v2/frames/tableofcontentsframe.h
View File

@ -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()
*/

4
taglib/mpeg/id3v2/frames/unsynchronizedlyricsframe.h
View File

@ -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()
*/

2
taglib/mpeg/id3v2/frames/urllinkframe.h
View File

@ -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/<description>"

4
taglib/mpeg/id3v2/id3v2header.h
View File

@ -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();

2
taglib/mpeg/xingheader.h
View File

@ -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);

2
taglib/ogg/flac/oggflacfile.h
View File

@ -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,

2
taglib/ogg/oggfile.h
View File

@ -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

4
taglib/ogg/oggpage.h
View File

@ -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()
*/

4
taglib/ogg/oggpageheader.h
View File

@ -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 <i>continued</i> 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()

2
taglib/ogg/xiphcomment.cpp
View File

@ -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))

2
taglib/ogg/xiphcomment.h
View File

@ -235,7 +235,7 @@ namespace TagLib {
List<FLAC::Picture *> 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);

2
taglib/riff/aiff/aifffile.h
View File

@ -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.

2
taglib/riff/rifffile.h
View File

@ -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

2
taglib/riff/wav/infotag.cpp
View File

@ -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;

8
taglib/riff/wav/infotag.h
View File

@ -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);

4
taglib/riff/wav/wavfile.h
View File

@ -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;

2
taglib/riff/wav/wavproperties.h
View File

@ -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.
*/

2
taglib/s3m/s3mfile.h
View File

@ -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 {

6
taglib/tag.h
View File

@ -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.

6
taglib/toolkit/taglib.h
View File

@ -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

12
taglib/toolkit/tbytevector.h
View File

@ -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()

2
taglib/toolkit/tdebuglistener.h
View File

@ -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.

2
taglib/toolkit/tfile.h
View File

@ -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

2
taglib/toolkit/tfilestream.h
View File

@ -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);

4
taglib/toolkit/tlist.h
View File

@ -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;

2
taglib/toolkit/tpropertymap.h
View File

@ -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

2
taglib/toolkit/tstring.cpp
View File

@ -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;
};

6
taglib/toolkit/tstring.h
View File

@ -97,7 +97,7 @@ namespace TagLib {
*/
enum Type {
/*!
* IS08859-1, or <i>Latin1</i> encoding. 8 bit characters.
* ISO-8859-1, or <i>Latin1</i> 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;

6
taglib/toolkit/tutils.h
View File

@ -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)
{

4
taglib/toolkit/tvariant.h
View File

@ -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;

2
taglib/trueaudio/trueaudiofile.h
View File

@ -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.

2
taglib/trueaudio/trueaudioproperties.h
View File

@ -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.
*/

4
taglib/wavpack/wavpackfile.h
View File

@ -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.
*

4
taglib/wavpack/wavpackproperties.h
View File

@ -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;

2
taglib/xm/xmfile.h
View File

@ -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 {