mirror/taglib
1
0
Fork 0
mirror of https://github.com/taglib/taglib.git synced 2026-04-12 17:09:50 -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
Download Patch File Download Diff File Expand all files Collapse all files

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