Update documentation
This commit is contained in:
parent
42d4d5ec5a
commit
f27dbd8934
|
@ -245,6 +245,7 @@ void createBackupFile(const std::string &originalPath, std::string &backupPath,
|
|||
* of \a fileInfo, but is specified here explicitly for higher flexibility.
|
||||
* \param backupStream Specifies the stream assembled using createBackupFile(); might be a default fstream if
|
||||
* no backup file has been created.
|
||||
* \param diag Specifies the container to add diagnostic messages to.
|
||||
* \param context Specifies the context used to add notifications.
|
||||
*/
|
||||
void handleFailureAfterFileModified(MediaFileInfo &fileInfo, const std::string &backupPath, NativeFileStream &outputStream,
|
||||
|
|
|
@ -42,8 +42,6 @@ bool Id3v1Tag::canEncodingBeUsed(TagTextEncoding encoding) const
|
|||
|
||||
/*!
|
||||
* \brief Parses tag information from the specified \a stream.
|
||||
* \param stream Specifies the stream to read from.
|
||||
* \param autoSeek Specifies whether the parser should automatically seek at the end of stream.
|
||||
* \throws Throws std::ios_base::failure when an IO error occurs.
|
||||
* \throws Throws TagParser::Failure or a derived exception when a parsing
|
||||
* error occurs.
|
||||
|
|
|
@ -782,11 +782,9 @@ u16string Id3v2Frame::parseWideString(const char *buffer, size_t dataSize, TagTe
|
|||
|
||||
/*!
|
||||
* \brief Parses a byte order mark from the specified \a buffer.
|
||||
*
|
||||
* \param buffer Specifies the buffer holding the byte order mark.
|
||||
* \param maxSize Specifies the maximal number of bytes to read from the buffer.
|
||||
* \param encoding Specifies the encoding of the string. Might be reset if a byte order mark is found.
|
||||
*
|
||||
* \remarks This method is not used anymore and might be deleted.
|
||||
*/
|
||||
void Id3v2Frame::parseBom(const char *buffer, size_t maxSize, TagTextEncoding &encoding, Diagnostics &diag)
|
||||
|
|
|
@ -477,7 +477,6 @@ inline const std::string &TagValue::mimeType() const
|
|||
|
||||
/*!
|
||||
* \brief Sets the MIME type.
|
||||
* \param value Specifies the mime type.
|
||||
* \remarks The usage of this meta information depends on the tag implementation.
|
||||
* \sa mimeType()
|
||||
*/
|
||||
|
@ -498,7 +497,6 @@ inline const std::string &TagValue::language() const
|
|||
|
||||
/*!
|
||||
* \brief Sets the language.
|
||||
* \param value Specifies the language.
|
||||
* \remarks The usage of this meta information depends on the tag implementation.
|
||||
* \sa language()
|
||||
*/
|
||||
|
|
|
@ -49,6 +49,7 @@ ostream &operator<<(ostream &os, const Sha256Checksum &checksum)
|
|||
|
||||
/*!
|
||||
* \brief The TestFile struct holds the path (relative to testfile dir) and checksum of a test file.
|
||||
* \remarks Generated with `scripts/list_required_testfiles.sh`.
|
||||
*/
|
||||
struct TestFile {
|
||||
const char *path;
|
||||
|
|
Loading…
Reference in New Issue