Updated the relevant comments

This commit is contained in:
Tsuda Kageyu
2013-07-04 21:44:28 +09:00
parent 1503909824
commit 30f62ba887
11 changed files with 218 additions and 78 deletions

View File

@ -137,6 +137,11 @@ bool Ogg::FLAC::File::save()
return Ogg::File::save();
}
bool Ogg::FLAC::File::hasXiphComment() const
{
return d->hasXiphComment;
}
////////////////////////////////////////////////////////////////////////////////
// private members
////////////////////////////////////////////////////////////////////////////////
@ -287,8 +292,3 @@ void Ogg::FLAC::File::scan()
d->scanned = true;
}
bool Ogg::FLAC::File::hasXiphComment() const
{
return d->hasXiphComment;
}

View File

@ -91,11 +91,19 @@ namespace TagLib {
/*!
* Returns the Tag for this file. This will always be a XiphComment.
*
* \note This always returns a valid pointer regardless of whether or not
* the file on disk has a XiphComment. Use hasXiphComment() to check if
* the file on disk actually has a XiphComment.
*
* \note The Tag <b>is still</b> owned by the FLAC::File and should not be
* deleted by the user. It will be deleted when the file (object) is
* destroyed.
*
* \see hasXiphComment()
*/
virtual XiphComment *tag() const;
/*!
* Returns the FLAC::Properties for this file. If no audio properties
* were read then this will return a null pointer.
@ -129,7 +137,9 @@ namespace TagLib {
long streamLength();
/*!
* Returns whether or not the file on disk contains a Xiph comment.
* Returns whether or not the file on disk actually has a XiphComment.
*
* \see tag()
*/
bool hasXiphComment() const;