Martchus
/
tagparser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix documentation which was still using the old namespace

This commit is contained in:
Martchus 2018-06-03 20:38:32 +02:00
parent b7d47cd374
commit 3265e0bea4
61 changed files with 183 additions and 186 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
aac/aacframe.cpp
View File

@ -517,7 +517,7 @@ AacIcsInfo::AacIcsInfo()
}
/*!
* \class Media::AacFrameElementParser
* \class TagParser::AacFrameElementParser
* \brief The AacFrameElementParser class parses AAC frame elements.
* \remarks
* - Only reads reads the basic syntax yet; does not reconstruct samples.

8
abstractattachment.cpp
View File

@ -15,7 +15,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \class Media::StreamDataBlock
* \class TagParser::StreamDataBlock
* \brief The StreamDataBlock class is a reference to a certain data block of a stream.
*/
@ -83,7 +83,7 @@ void StreamDataBlock::copyTo(ostream &stream) const
}
/*!
* \class Media::FileDataBlock
* \class TagParser::FileDataBlock
* \brief The FileDataBlock class is a reference to a certain data block of a file stream.
*/
@ -106,7 +106,7 @@ FileDataBlock::FileDataBlock(const string &path, Diagnostics &diag)
}
/*!
* \class Media::AbstractAttachment
* \class TagParser::AbstractAttachment
* \brief The AbstractAttachment class parses and stores attachment information.
*/
@ -146,7 +146,7 @@ void AbstractAttachment::clear()
* or the attachment gets destroyed.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived class when a parsing
* \throws Throws TagParser::Failure or a derived class when a parsing
* error occurs.
*
* When such an exception is thrown, the attachment remains unchanged.

2
abstractchapter.cpp
View File

@ -8,7 +8,7 @@ using namespace ChronoUtilities;
namespace TagParser {
/*!
* \class Media::AbstractChapter
* \class TagParser::AbstractChapter
* \brief The AbstractChapter class parses chapter information.
*/

8
abstractcontainer.cpp
View File

@ -9,7 +9,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \class Media::AbstractContainer
* \class TagParser::AbstractContainer
* \brief The AbstractContainer class provides an interface and common functionality to parse and make a certain container format.
*/
@ -122,7 +122,7 @@ void AbstractContainer::parseTracks(Diagnostics &diag)
* have been specified when constructing the object.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void AbstractContainer::parseChapters(Diagnostics &diag)
@ -141,7 +141,7 @@ void AbstractContainer::parseChapters(Diagnostics &diag)
* have been specified when constructing the object.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void AbstractContainer::parseAttachments(Diagnostics &diag)
@ -157,7 +157,7 @@ void AbstractContainer::parseAttachments(Diagnostics &diag)
* \brief Rewrites the file to apply changed tag information.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void AbstractContainer::makeFile(Diagnostics &diag, AbortableProgressFeedback &progress)

6
abstracttrack.cpp
View File

@ -14,7 +14,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \class Media::AbstractTrack
* \class TagParser::AbstractTrack
* \brief The AbstractTrack class parses and stores technical information about
* video, audio and other kinds of media tracks.
*
@ -205,7 +205,7 @@ string AbstractTrack::description() const
* The parsed information can be accessed using the corresponding methods.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void AbstractTrack::parseHeader(Diagnostics &diag)
@ -226,7 +226,7 @@ void AbstractTrack::parseHeader(Diagnostics &diag)
* It needs to be implemented when subclassing this class.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/

14
abstracttrack.h
View File

@ -27,13 +27,13 @@ class Mp4Track;
*/
enum class TrackType {
Unspecified, /**< The track type is not specified. */
MatroskaTrack, /**< The track is a Media::MatroskaTrack. */
MpegAudioFrameStream, /**< The track is a Media::MpegAudioFrameStream. */
Mp4Track, /**< The track is a Media::Mp4Track. */
WaveAudioStream, /**< The track is a Media::WaveAudioStream. */
OggStream, /**< The track is a Media::OggStream. */
AdtsStream, /**< The track is a Media::AdtsStream. */
FlacStream, /**< The track is a Media::FlacStream. */
MatroskaTrack, /**< The track is a TagParser::MatroskaTrack. */
MpegAudioFrameStream, /**< The track is a TagParser::MpegAudioFrameStream. */
Mp4Track, /**< The track is a TagParser::Mp4Track. */
WaveAudioStream, /**< The track is a TagParser::WaveAudioStream. */
OggStream, /**< The track is a TagParser::OggStream. */
AdtsStream, /**< The track is a TagParser::AdtsStream. */
FlacStream, /**< The track is a TagParser::FlacStream. */
};
class TAG_PARSER_EXPORT AbstractTrack {

2
adts/adtsframe.cpp
View File

@ -10,7 +10,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \class Media::AdtsFrame
* \class TagParser::AdtsFrame
* \brief The AdtsFrame class is used to parse "Audio Data Transport Stream" frames.
*/

8
adts/adtsframe.h
View File

@ -69,7 +69,7 @@ inline bool AdtsFrame::hasCrc() const
/*!
* \brief Returns the MPEG-4 audio object type ID.
* \sa Media::Mpeg4AudioObjectIds
* \sa TagParser::Mpeg4AudioObjectIds
* \sa Mpeg4AudioObjectIds::idToMediaFormat()
*/
inline byte AdtsFrame::mpeg4AudioObjectId() const
@ -79,7 +79,7 @@ inline byte AdtsFrame::mpeg4AudioObjectId() const
/*!
* \brief Returns the MPEG-4 sample rate index.
* \sa Media::mpeg4SampleRateTable
* \sa TagParser::mpeg4SampleRateTable
*/
inline byte AdtsFrame::mpeg4SamplingFrequencyIndex() const
{
@ -88,8 +88,8 @@ inline byte AdtsFrame::mpeg4SamplingFrequencyIndex() const
/*!
* \brief Returns the MPEG-4 channel configuration.
* \sa Media::Mpeg4ChannelConfigs
* \sa Media::mpeg4SampleRateTable::channelConfigString()
* \sa TagParser::Mpeg4ChannelConfigs
* \sa TagParser::mpeg4SampleRateTable::channelConfigString()
*/
inline byte AdtsFrame::mpeg4ChannelConfig() const
{

4
adts/adtsstream.cpp
View File

@ -11,8 +11,8 @@ using namespace std;
namespace TagParser {
/*!
* \class Media::AdtsStream
* \brief Implementation of Media::AbstractTrack for ADTS streams.
* \class TagParser::AdtsStream
* \brief Implementation of TagParser::AbstractTrack for ADTS streams.
*/
void AdtsStream::internalParseHeader(Diagnostics &diag)

2
aspectratio.cpp
View File

@ -5,7 +5,7 @@ using namespace std;
namespace TagParser {
/*!
* \struct Media::AspectRatio
* \struct TagParser::AspectRatio
* \brief The AspectRatio struct defines an aspect ratio.
*/

12
avc/avcinfo.cpp
View File

@ -15,7 +15,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \struct Media::SpsInfo
* \struct TagParser::SpsInfo
* \brief The SpsInfo struct holds the sequence parameter set.
*/
@ -217,7 +217,7 @@ void SpsInfo::parse(BinaryReader &reader, uint32 maxSize)
}
/*!
* \struct Media::PpsInfo
* \struct TagParser::PpsInfo
* \brief The PpsInfo struct holds the picture parameter set.
*/
@ -257,7 +257,7 @@ void PpsInfo::parse(BinaryReader &reader, uint32 maxSize)
}
/*!
* \struct Media::HrdParameters
* \struct TagParser::HrdParameters
* \brief The HrdParameters struct holds "Hypothetical Reference Decoder" parameters.
* \remarks This is "a model for thinking about the decoding process".
*/
@ -283,18 +283,18 @@ void HrdParameters::parse(IoUtilities::BitReader &reader)
}
/*!
* \struct Media::TimingInfo
* \struct TagParser::TimingInfo
* \brief The TimingInfo struct holds timing information (part of SPS info).
*/
/*!
* \struct Media::SliceInfo
* \struct TagParser::SliceInfo
* \brief The SliceInfo struct holds the slice information of an AVC frame.
* \remarks currently not useful, might be removed
*/
/*!
* \struct Media::AvcFrame
* \struct TagParser::AvcFrame
* \brief The AvcFrame struct holds an AVC frame.
* \remarks currently not useful, might be removed
*/

2
avi/bitmapinfoheader.cpp
View File

@ -7,7 +7,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \class Media::BitmapInfoHeader
* \class TagParser::BitmapInfoHeader
* \brief The BitmapInfoHeader class parses the BITMAPINFOHEADER structure defined by MS.
*/

2
backuphelper.cpp
View File

@ -24,7 +24,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \namespace Media::BackupHelper
* \namespace TagParser::BackupHelper
* \brief Helps to create and restore backup files when rewriting
* files to apply changed tag information.
*

7
basicfileinfo.cpp
View File

@ -6,18 +6,15 @@ using namespace std;
using namespace ConversionUtilities;
/*!
* \namespace Media
* \brief Contains all classes and functions of the TagInfo library.
*/
namespace TagParser {
/*!
* \class Media::BasicFileInfo
* \class BasicFileInfo
* \brief The BasicFileInfo class provides basic file information such as
* file name, extension, directory and size for a specified file.
*/
namespace TagParser {
/*!
* \brief Constructs a new BasicFileInfo for the specified file.
*

14
exceptions.cpp
View File

@ -5,7 +5,7 @@ using namespace std;
namespace TagParser {
/*!
* \class Media::Failure
* \class TagParser::Failure
* \brief The class inherits from std::exception and serves as base class for exceptions
* thrown by the elements of the Media namespace.
*/
@ -33,7 +33,7 @@ const char *Failure::what() const USE_NOTHROW
}
/*!
* \class Media::NoDataFoundException
* \class TagParser::NoDataFoundException
* \brief The exception that is thrown when the data to be parsed holds no
* parsable information.
*/
@ -61,7 +61,7 @@ const char *NoDataFoundException::what() const USE_NOTHROW
}
/*!
* \class Media::InvalidDataException
* \class TagParser::InvalidDataException
* \brief The exception that is thrown when the data to be parsed or to be made seems
* invalid and therefore can not be parsed.
*/
@ -89,7 +89,7 @@ const char *InvalidDataException::what() const USE_NOTHROW
}
/*!
* \class Media::TruncatedDataException
* \class TagParser::TruncatedDataException
* \brief The exception that is thrown when the data to be parsed is truncated
* and therefore can not be parsed at all.
*/
@ -117,7 +117,7 @@ const char *TruncatedDataException::what() const USE_NOTHROW
}
/*!
* \class Media::OperationAbortedException
* \class TagParser::OperationAbortedException
* \brief The exception that is thrown when an operation has been stopped
* and thus not successfully completed because it has been aborted.
*/
@ -145,7 +145,7 @@ const char *OperationAbortedException::what() const USE_NOTHROW
}
/*!
* \class Media::VersionNotSupportedException
* \class TagParser::VersionNotSupportedException
* \brief The exception that is thrown when an operation fails because the
* detected or specified version is not supported by the implementation.
*/
@ -173,7 +173,7 @@ const char *VersionNotSupportedException::what() const USE_NOTHROW
}
/*!
* \class Media::NotImplementedException
* \class TagParser::NotImplementedException
* \brief This exception is thrown when the an operation is invoked that has not
* been implemented yet.
*/

4
fieldbasedtag.h
View File

@ -9,7 +9,7 @@
namespace TagParser {
/*!
* \class Media::FieldMapBasedTagTraits
* \class TagParser::FieldMapBasedTagTraits
* \brief Defines traits for the specified \a ImplementationType.
*
* A template specialization for each FieldMapBasedTag subclass must be provided.
@ -18,7 +18,7 @@ template <typename ImplementationType> class FieldMapBasedTagTraits {
};
/*!
* \class Media::FieldMapBasedTag
* \class TagParser::FieldMapBasedTag
* \brief The FieldMapBasedTag provides a generic implementation of Tag which stores
* the tag fields using std::multimap.
*

6
flac/flacmetadata.cpp
View File

@ -18,7 +18,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \class Media::FlacMetaDataBlockHeader
* \class TagParser::FlacMetaDataBlockHeader
* \brief The FlacMetaDataBlockHeader class is a FLAC "METADATA_BLOCK_HEADER" parser and maker.
* \sa https://xiph.org/flac/format.html
*/
@ -47,7 +47,7 @@ void FlacMetaDataBlockHeader::makeHeader(std::ostream &outputStream)
}
/*!
* \class Media::FlacMetaDataBlockStreamInfo
* \class TagParser::FlacMetaDataBlockStreamInfo
* \brief The FlacMetaDataBlockStreamInfo class is a FLAC "METADATA_BLOCK_STREAMINFO" parser.
* \sa https://xiph.org/flac/format.html
*/
@ -71,7 +71,7 @@ void FlacMetaDataBlockStreamInfo::parse(const char *buffer)
}
/*!
* \class Media::FlacMetaDataBlockPicture
* \class TagParser::FlacMetaDataBlockPicture
* \brief The FlacMetaDataBlockPicture class is a FLAC "METADATA_BLOCK_PICTURE" parser and maker.
* \sa https://xiph.org/flac/format.html
*/

4
flac/flacstream.cpp
View File

@ -21,8 +21,8 @@ using namespace ChronoUtilities;
namespace TagParser {
/*!
* \class Media::FlacStream
* \brief Implementation of Media::AbstractTrack for raw FLAC streams.
* \class TagParser::FlacStream
* \brief Implementation of TagParser::AbstractTrack for raw FLAC streams.
*/
/*!

2
flac/flactooggmappingheader.cpp
View File

@ -12,7 +12,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::FlacToOggMappingHeader
* \class TagParser::FlacToOggMappingHeader
* \brief The FlacToOggMappingHeader class is a FLAC-to-Ogg mapping header parser.
* \sa https://xiph.org/flac/ogg_mapping.html
*/

4
genericcontainer.h
View File

@ -10,11 +10,11 @@
namespace TagParser {
/*!
* \class Media::GenericContainer
* \class TagParser::GenericContainer
* \brief The GenericContainer class helps parsing header, track, tag and chapter information
* of a file.
*
* \tparam FileInfoType Specifies the file info class (a class derived from Media::BasicFileInfo) which is used to specify the related file.
* \tparam FileInfoType Specifies the file info class (a class derived from TagParser::BasicFileInfo) which is used to specify the related file.
* \tparam TagType Specifies the class which is used to deal with the tag information of the file.
* \tparam TrackType Specifies the class which is used to deal with the track of the file.
* \tparam ElementType Specifies the class which is used to deal with the elements the file consists of.

12
genericfileelement.h
View File

@ -25,7 +25,7 @@ namespace TagParser {
class Diagnostics;
/*!
* \class Media::FileElementTraits
* \class TagParser::FileElementTraits
* \brief Defines traits for the specified \a ImplementationType.
*
* A template specialization for each GenericFileElement should
@ -37,7 +37,7 @@ template <typename ImplementationType> class FileElementTraits {
};
/*!
* \class Media::GenericFileElement
* \class TagParser::GenericFileElement
* \brief The GenericFileElement class helps to parse binary files which consist
* of an arboreal element strucutre.
* \tparam ImplementationType Specifies the type of the actual implementation.
@ -765,7 +765,7 @@ template <class ImplementationType> void GenericFileElement<ImplementationType>:
* does nothing. To force reparsing call reparse().
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
template <class ImplementationType> void GenericFileElement<ImplementationType>::parse(Diagnostics &diag)
@ -787,7 +787,7 @@ template <class ImplementationType> void GenericFileElement<ImplementationType>:
* clears the parsed information and reparses the header.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*
* \sa parse()
@ -806,7 +806,7 @@ template <class ImplementationType> void GenericFileElement<ImplementationType>:
* If padding is found its size will be set to \a paddingSize if not nullptr.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*
* \sa parse()
@ -985,7 +985,7 @@ template <class ImplementationType> constexpr byte GenericFileElement<Implementa
* It needs to be implemented when subclassing.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*
* \sa parse()

2
generictagfield.h
View File

@ -8,7 +8,7 @@ namespace TagParser {
template <class implementationType> class TagField;
/*!
* \class Media::TagFieldTraits
* \class TagParser::TagFieldTraits
* \brief Defines traits for the specified \a ImplementationType.
*
* A template specialization for each TagField subclass must be provided.

8
id3/id3v1tag.cpp
View File

@ -14,8 +14,8 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::Id3v1Tag
* \brief Implementation of Media::Tag for ID3v1 tags.
* \class TagParser::Id3v1Tag
* \brief Implementation of TagParser::Tag for ID3v1 tags.
*/
/*!
@ -45,7 +45,7 @@ bool Id3v1Tag::canEncodingBeUsed(TagTextEncoding encoding) const
* \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 Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void Id3v1Tag::parse(std::istream &stream, Diagnostics &diag)
@ -79,7 +79,7 @@ void Id3v1Tag::parse(std::istream &stream, Diagnostics &diag)
* \brief Writes tag information to the specified \a stream.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void Id3v1Tag::make(ostream &stream, Diagnostics &diag)

12
id3/id3v2frame.cpp
View File

@ -29,7 +29,7 @@ enum Id3v2TextEncodingByte : byte { Ascii, Utf16WithBom, Utf16BigEndianWithoutBo
constexpr auto maxId3v2FrameDataSize(numeric_limits<uint32>::max() - 15);
/*!
* \class Media::Id3v2Frame
* \class TagParser::Id3v2Frame
* \brief The Id3v2Frame class is used by Id3v2Tag to store the fields.
*/
@ -109,7 +109,7 @@ template <class stringtype> int parseGenreIndex(const stringtype &denotation)
* at the beginning of the frame to be parsed.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void Id3v2Frame::parse(BinaryReader &reader, uint32 version, uint32 maximalSize, Diagnostics &diag)
@ -314,7 +314,7 @@ void Id3v2Frame::parse(BinaryReader &reader, uint32 version, uint32 maximalSize,
* \returns Returns a Id3v2FrameMaker object which can be used to actually make the frame.
* \remarks The field must NOT be mutated after making is prepared when it is intended to actually
* make the field using the make method of the returned object.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*
* This method might be useful when it is necessary to know the size of the field before making it.
@ -329,7 +329,7 @@ Id3v2FrameMaker Id3v2Frame::prepareMaking(byte version, Diagnostics &diag)
* specified ID3v2 \a version.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void Id3v2Frame::make(BinaryWriter &writer, byte version, Diagnostics &diag)
@ -351,7 +351,7 @@ void Id3v2Frame::reset()
}
/*!
* \class Media::Id3v2FrameMaker
* \class TagParser::Id3v2FrameMaker
* \brief The Id3v2FrameMaker class helps making ID3v2 frames.
* It allows to calculate the required size.
* \sa See Id3v2FrameMaker::prepareMaking() for more information.
@ -536,7 +536,7 @@ Id3v2FrameMaker::Id3v2FrameMaker(Id3v2Frame &frame, byte version, Diagnostics &d
* the specified \a writer.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Assumes the data is already validated and thus does NOT
* throw Media::Failure or a derived exception.
* throw TagParser::Failure or a derived exception.
*/
void Id3v2FrameMaker::make(BinaryWriter &writer)
{

16
id3/id3v2tag.cpp
View File

@ -16,8 +16,8 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::Id3v2Tag
* \brief Implementation of Media::Tag for ID3v2 tags.
* \class TagParser::Id3v2Tag
* \brief Implementation of TagParser::Tag for ID3v2 tags.
*/
Id3v2Tag::IdentifierType Id3v2Tag::internallyGetFieldId(KnownField field) const
@ -240,7 +240,7 @@ TagDataType Id3v2Tag::internallyGetProposedDataType(const uint32 &id) const
* \brief Parses tag information from the specified \a stream.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void Id3v2Tag::parse(istream &stream, const uint64 maximalSize, Diagnostics &diag)
@ -354,7 +354,7 @@ void Id3v2Tag::parse(istream &stream, const uint64 maximalSize, Diagnostics &dia
* \returns Returns a Id3v2TagMaker object which can be used to actually make the tag.
* \remarks The tag must NOT be mutated after making is prepared when it is intended to actually
* make the tag using the make method of the returned object.
* \throws Throws Media::Failure or a derived exception when a making error occurs.
* \throws Throws TagParser::Failure or a derived exception when a making error occurs.
*
* This method might be useful when it is necessary to know the size of the tag before making it.
* \sa make()
@ -368,7 +368,7 @@ Id3v2TagMaker Id3v2Tag::prepareMaking(Diagnostics &diag)
* \brief Writes tag information to the specified \a stream.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void Id3v2Tag::make(ostream &stream, uint32 padding, Diagnostics &diag)
@ -388,7 +388,7 @@ void Id3v2Tag::setVersion(byte majorVersion, byte revisionVersion)
}
/*!
* \class Media::FrameComparer
* \class TagParser::FrameComparer
* \brief Defines the order which is used to store ID3v2 frames.
*
* The order is: unique file id, title, other text frames, other frames, cover
@ -449,7 +449,7 @@ bool FrameComparer::operator()(const uint32 &lhsRef, const uint32 &rhsRef) const
}
/*!
* \class Media::Id3v2TagMaker
* \class TagParser::Id3v2TagMaker
* \brief The Id3v2TagMaker class helps writing ID3v2 tags.
*
* An instance can be obtained using the Id3v2Tag::prepareMaking() method.
@ -492,7 +492,7 @@ Id3v2TagMaker::Id3v2TagMaker(Id3v2Tag &tag, Diagnostics &diag)
* specified \a stream.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Assumes the data is already validated and thus does NOT
* throw Media::Failure or a derived exception.
* throw TagParser::Failure or a derived exception.
*/
void Id3v2TagMaker::make(std::ostream &stream, uint32 padding, Diagnostics &diag)
{

2
matroska/ebmlelement.cpp
View File

@ -23,7 +23,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::EbmlElement
* \class TagParser::EbmlElement
* \brief The EbmlElement class helps to parse EBML files such as Matroska files.
*/

12
matroska/matroskaattachment.cpp
View File

@ -15,15 +15,15 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \class Media::MatroskaAttachment
* \brief Implementation of Media::AbstractAttachment for the Matroska container.
* \class TagParser::MatroskaAttachment
* \brief Implementation of TagParser::AbstractAttachment for the Matroska container.
*/
/*!
* \brief Parses attachment from the specified \a attachedFileElement.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void MatroskaAttachment::parse(EbmlElement *attachedFileElement, Diagnostics &diag)
@ -87,7 +87,7 @@ void MatroskaAttachment::parse(EbmlElement *attachedFileElement, Diagnostics &di
/*!
* \brief Writes the attachment to the specified \a stream (makes an "AttachedFile"-element).
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
* \sa prepareMaking()
*/
@ -101,7 +101,7 @@ void MatroskaAttachment::make(std::ostream &stream, Diagnostics &diag)
}
/*!
* \class Media::MatroskaAttachmentMaker
* \class TagParser::MatroskaAttachmentMaker
* \brief The MatroskaAttachmentMaker class helps writing Matroska "AttachedFile"-elements which contain an attachment.
*
* An instance can be obtained using the MatroskaAttachment::prepareMaking() method.
@ -141,7 +141,7 @@ MatroskaAttachmentMaker::MatroskaAttachmentMaker(MatroskaAttachment &attachment,
* specified \a stream (makes an "AttachedFile"-element).
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Assumes the data is already validated and thus does NOT
* throw Media::Failure or a derived exception.
* throw TagParser::Failure or a derived exception.
*/
void MatroskaAttachmentMaker::make(ostream &stream, Diagnostics &diag) const
{

2
matroska/matroskaattachment.h
View File

@ -76,7 +76,7 @@ inline EbmlElement *MatroskaAttachment::attachedFileElement() const
* \returns Returns a MatroskaAttachmentMaker object which can be used to actually make the attachment.
* \remarks The attachment must NOT be mutated after making is prepared when it is intended to actually
* make the attachment using the make method of the returned object.
* \throws Throws Media::Failure or a derived exception when a making error occurs.
* \throws Throws TagParser::Failure or a derived exception when a making error occurs.
*
* This method might be useful when it is necessary to know the size of the attachment before making it.
* \sa make()

4
matroska/matroskacontainer.cpp
View File

@ -34,7 +34,7 @@ using namespace ChronoUtilities;
namespace TagParser {
/*!
* \class Media::MatroskaContainer
* \class TagParser::MatroskaContainer
* \brief Implementation of GenericContainer<MediaFileInfo, MatroskaTag, MatroskaTrack, EbmlElement>.
*/
@ -602,7 +602,7 @@ finish:
* This private method is called when parsing the header.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void MatroskaContainer::parseSegmentInfo(Diagnostics &diag)

2
matroska/matroskacues.cpp
View File

@ -25,7 +25,7 @@ namespace TagParser {
*/
/*!
* \class Media::MatroskaCuePositionUpdater
* \class TagParser::MatroskaCuePositionUpdater
* \brief The MatroskaCuePositionUpdater class helps to rewrite the "Cues"-element with shifted positions.
*
* This class is used when rewriting a Matroska file to save changed tag information.

2
matroska/matroskaseekinfo.cpp
View File

@ -15,7 +15,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::MatroskaSeekInfo
* \class TagParser::MatroskaSeekInfo
* \brief The MatroskaSeekInfo class helps parsing and making "SeekHead"-elements.
*/

16
matroska/matroskatag.cpp
View File

@ -13,8 +13,8 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::MatroskaTag
* \brief Implementation of Media::Tag for the Matroska container.
* \class TagParser::MatroskaTag
* \brief Implementation of TagParser::Tag for the Matroska container.
*/
MatroskaTag::IdentifierType MatroskaTag::internallyGetFieldId(KnownField field) const
@ -104,7 +104,7 @@ KnownField MatroskaTag::internallyGetKnownField(const IdentifierType &id) const
* \brief Parses tag information from the specified \a tagElement.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void MatroskaTag::parse(EbmlElement &tagElement, Diagnostics &diag)
@ -140,7 +140,7 @@ void MatroskaTag::parse(EbmlElement &tagElement, Diagnostics &diag)
* \returns Returns a MatroskaTagMaker object which can be used to actually make the tag.
* \remarks The tag must NOT be mutated after making is prepared when it is intended to actually
* make the tag using the make() method of the returned object.
* \throws Throws Media::Failure or a derived exception when a making error occurs.
* \throws Throws TagParser::Failure or a derived exception when a making error occurs.
*
* This method might be useful when it is necessary to know the size of the tag before making it.
* \sa make()
@ -154,7 +154,7 @@ MatroskaTagMaker MatroskaTag::prepareMaking(Diagnostics &diag)
/*!
* \brief Writes tag information to the specified \a stream (makes a "Tag"-element).
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
* \sa prepareMaking()
* \todo Make inline in next major release.
@ -168,7 +168,7 @@ void MatroskaTag::make(ostream &stream, Diagnostics &diag)
* \brief Parses the specified \a targetsElement.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void MatroskaTag::parseTargets(EbmlElement &targetsElement, Diagnostics &diag)
@ -226,7 +226,7 @@ void MatroskaTag::parseTargets(EbmlElement &targetsElement, Diagnostics &diag)
}
/*!
* \class Media::MatroskaTagMaker
* \class TagParser::MatroskaTagMaker
* \brief The MatroskaTagMaker class helps writing Matroska "Tag"-elements storing tag information.
*
* An instance can be obtained using the MatroskaTag::prepareMaking() method.
@ -276,7 +276,7 @@ MatroskaTagMaker::MatroskaTagMaker(MatroskaTag &tag, Diagnostics &diag)
* specified \a stream (makes a "Tag"-element).
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Assumes the data is already validated and thus does NOT
* throw Media::Failure or a derived exception.
* throw TagParser::Failure or a derived exception.
*/
void MatroskaTagMaker::make(ostream &stream) const
{

12
matroska/matroskatagfield.cpp
View File

@ -15,7 +15,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::MatroskaTagField
* \class TagParser::MatroskaTagField
* \brief The MatroskaTagField class is used by MatroskaTag to store the fields.
*/
@ -41,7 +41,7 @@ MatroskaTagField::MatroskaTagField(const string &id, const TagValue &value)
* represents the fields of a MatroskaTag.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void MatroskaTagField::reparse(EbmlElement &simpleTagElement, Diagnostics &diag, bool parseNestedFields)
@ -134,7 +134,7 @@ void MatroskaTagField::reparse(EbmlElement &simpleTagElement, Diagnostics &diag,
* \returns Returns a MatroskaTagFieldMaker object which can be used to actually make the field.
* \remarks The field must NOT be mutated after making is prepared when it is intended to actually
* make the field using the make method of the returned object.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*
* This method might be useful when it is necessary to know the size of the field before making it.
@ -158,7 +158,7 @@ MatroskaTagFieldMaker MatroskaTagField::prepareMaking(Diagnostics &diag)
/*!
* \brief Saves the field to the specified \a stream (makes a "SimpleTag" element). *
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void MatroskaTagField::make(ostream &stream, Diagnostics &diag)
@ -167,7 +167,7 @@ void MatroskaTagField::make(ostream &stream, Diagnostics &diag)
}
/*!
* \class Media::MatroskaTagFieldMaker
* \class TagParser::MatroskaTagFieldMaker
* \brief The MatroskaTagFieldMaker class helps making tag fields.
* It allows to calculate the required size.
* \sa See MatroskaTagField::prepareMaking() for more information.
@ -219,7 +219,7 @@ MatroskaTagFieldMaker::MatroskaTagFieldMaker(MatroskaTagField &field, Diagnostic
* specified \a stream (makes a "SimpleTag" element). *
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Assumes the data is already validated and thus does NOT
* throw Media::Failure or a derived exception.
* throw TagParser::Failure or a derived exception.
*/
void MatroskaTagFieldMaker::make(ostream &stream) const
{

8
matroska/matroskatrack.cpp
View File

@ -24,8 +24,8 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::MatroskaTrack
* \brief Implementation of Media::AbstractTrack for the Matroska container.
* \class TagParser::MatroskaTrack
* \brief Implementation of TagParser::AbstractTrack for the Matroska container.
*/
/*!
@ -540,7 +540,7 @@ void MatroskaTrack::internalParseHeader(Diagnostics &diag)
}
/*!
* \class Media::MatroskaTrackHeaderMaker
* \class TagParser::MatroskaTrackHeaderMaker
* \brief The MatroskaTrackHeaderMaker class helps writing Matroska "TrackEntry"-elements storing track header information.
*
* An instance can be obtained using the MatroskaTrack::prepareMakingHeader() method.
@ -595,7 +595,7 @@ MatroskaTrackHeaderMaker::MatroskaTrackHeaderMaker(const MatroskaTrack &track, D
* specified \a stream (makes a "TrackEntry"-element).
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Assumes the data is already validated and thus does NOT
* throw Media::Failure or a derived exception.
* throw TagParser::Failure or a derived exception.
*/
void MatroskaTrackHeaderMaker::make(ostream &stream) const
{

4
matroska/matroskatrack.h
View File

@ -75,7 +75,7 @@ private:
* header.
* \remarks The track must NOT be mutated after making is prepared when it is intended to actually
* make the tag using the make() method of the returned object.
* \throws Throws Media::Failure or a derived exception when a making error occurs.
* \throws Throws TagParser::Failure or a derived exception when a making error occurs.
*
* This method might be useful when it is necessary to know the size of the track header before making
* it.
@ -90,7 +90,7 @@ inline MatroskaTrackHeaderMaker MatroskaTrack::prepareMakingHeader(Diagnostics &
/*!
* \brief Writes header information to the specified \a stream (makes a "TrackEntry"-element).
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
* \sa prepareMaking()
* \todo Make inline in next major release.

14
mediafileinfo.cpp
View File

@ -66,7 +66,7 @@ namespace TagParser {
#endif
/*!
* \class Media::MediaFileInfo
* \class TagParser::MediaFileInfo
* \brief The MediaFileInfo class allows to read and write tag information providing
* a container/tag format independent interface.
*
@ -144,7 +144,7 @@ MediaFileInfo::~MediaFileInfo()
* container(), mp4Container() and matroskaContainer() will return the parsed
* information.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
* \sa isContainerParsed(), parseTracks(), parseTag(), parseChapters(), parseEverything()
*/
@ -287,7 +287,7 @@ startParsingSignature:
* hasTracksOfType() will return the parsed information.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
* \remarks parseContainerFormat() must be called before.
* \sa areTracksParsed(), parseContainerFormat(), parseTags(), parseChapters(), parseEverything()
@ -355,7 +355,7 @@ void MediaFileInfo::parseTracks(Diagnostics &diag)
*
* Previously assigned but not applied tag information will be discarted.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
* \remarks parseContainerFormat() must be called before.
* \sa isTagParsed(), parseContainerFormat(), parseTracks(), parseChapters(), parseEverything()
@ -437,7 +437,7 @@ void MediaFileInfo::parseTags(Diagnostics &diag)
* This method parses the chapters of the current file if not been parsed yet.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
* \remarks parseContainerFormat() must be called before.
* \sa areChaptersParsed(), parseContainerFormat(), parseTracks(), parseTags(), parseEverything()
@ -472,7 +472,7 @@ void MediaFileInfo::parseChapters(Diagnostics &diag)
* This method parses the attachments of the current file if not been parsed yet.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
* \remarks parseContainerFormat() must be called before.
* \sa areChaptersParsed(), parseContainerFormat(), parseTracks(), parseTags(), parseEverything()
@ -644,7 +644,7 @@ bool MediaFileInfo::createAppropriateTags(const TagCreationSettings &settings)
* will be created to replace the old file.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making error occurs.
* \throws Throws TagParser::Failure or a derived exception when a making error occurs.
*
* \remarks Tags and tracks need to be parsed without errors before this method can be called.
* All previous parsing results are cleared (using clearParsingResults()). Hence

2
mediaformat.cpp
View File

@ -5,7 +5,7 @@ namespace TagParser {
using namespace SubFormats;
/*!
* \class Media::MediaFormat
* \class TagParser::MediaFormat
* \brief The MediaFormat class specifies the format of media data.
*/

2
mp4/mp4atom.cpp
View File

@ -20,7 +20,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::Mp4Atom
* \class TagParser::Mp4Atom
* \brief The Mp4Atom class helps to parse MP4 files.
*/

4
mp4/mp4container.cpp
View File

@ -25,7 +25,7 @@ using namespace ChronoUtilities;
namespace TagParser {
/*!
* \class Media::Mp4Container
* \class TagParser::Mp4Container
* \brief Implementation of GenericContainer<MediaFileInfo, Mp4Tag, Mp4Track, Mp4Atom>.
*/
@ -874,7 +874,7 @@ calculatePadding:
* updated (this is not tested yet since I don't have files using this atom).
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void Mp4Container::updateOffsets(const std::vector<int64> &oldMdatOffsets, const std::vector<int64> &newMdatOffsets, Diagnostics &diag)

2
mp4/mp4ids.cpp
View File

@ -197,7 +197,7 @@ namespace Mp4FormatExtensionIds {
namespace Mpeg4ElementaryStreamObjectIds {
/*!
* \brief Returns the Media::MediaFormat denoted by the specified MPEG-4 stream ID.
* \brief Returns the TagParser::MediaFormat denoted by the specified MPEG-4 stream ID.
*/
MediaFormat streamObjectTypeFormat(byte streamObjectTypeId)
{

16
mp4/mp4tag.cpp
View File

@ -15,7 +15,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::Mp4ExtendedFieldId
* \class TagParser::Mp4ExtendedFieldId
* \brief The Mp4ExtendedFieldId specifies parameter for an extended field denoted via Mp4TagAtomIds::Extended.
*/
@ -41,8 +41,8 @@ Mp4ExtendedFieldId::Mp4ExtendedFieldId(KnownField field)
}
/*!
* \class Media::Mp4Tag
* \brief Implementation of Media::Tag for the MP4 container.
* \class TagParser::Mp4Tag
* \brief Implementation of TagParser::Tag for the MP4 container.
*/
bool Mp4Tag::canEncodingBeUsed(TagTextEncoding encoding) const
@ -313,7 +313,7 @@ bool Mp4Tag::hasField(KnownField field) const
* \brief Parses tag information from the specified \a metaAtom.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void Mp4Tag::parse(Mp4Atom &metaAtom, Diagnostics &diag)
@ -377,7 +377,7 @@ void Mp4Tag::parse(Mp4Atom &metaAtom, Diagnostics &diag)
* \returns Returns a Mp4TagMaker object which can be used to actually make the tag.
* \remarks The tag must NOT be mutated after making is prepared when it is intended to actually
* make the tag using the make method of the returned object.
* \throws Throws Media::Failure or a derived exception when a making error occurs.
* \throws Throws TagParser::Failure or a derived exception when a making error occurs.
*
* This method might be useful when it is necessary to know the size of the tag before making it.
* \sa make()
@ -390,7 +390,7 @@ Mp4TagMaker Mp4Tag::prepareMaking(Diagnostics &diag)
/*!
* \brief Writes tag information to the specified \a stream.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void Mp4Tag::make(ostream &stream, Diagnostics &diag)
@ -399,7 +399,7 @@ void Mp4Tag::make(ostream &stream, Diagnostics &diag)
}
/*!
* \class Media::Mp4TagMaker
* \class TagParser::Mp4TagMaker
* \brief The Mp4TagMaker class helps writing MP4 tags.
*
* An instance can be obtained using the Mp4Tag::prepareMaking() method.
@ -445,7 +445,7 @@ Mp4TagMaker::Mp4TagMaker(Mp4Tag &tag, Diagnostics &diag)
* specified \a stream.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Assumes the data is already validated and thus does NOT
* throw Media::Failure or a derived exception.
* throw TagParser::Failure or a derived exception.
*/
void Mp4TagMaker::make(ostream &stream, Diagnostics &diag)
{

12
mp4/mp4tagfield.cpp
View File

@ -20,7 +20,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::Mp4TagField
* \class TagParser::Mp4TagField
* \brief The Mp4TagField class is used by Mp4Tag to store the fields.
*/
@ -68,7 +68,7 @@ Mp4TagField::Mp4TagField(const string &mean, const string &name, const TagValue
* Each child of the "ilst" atom holds one field of the Mp4Tag.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void Mp4TagField::reparse(Mp4Atom &ilstChild, Diagnostics &diag)
@ -271,7 +271,7 @@ void Mp4TagField::reparse(Mp4Atom &ilstChild, Diagnostics &diag)
* \returns Returns a Mp4TagFieldMaker object which can be used to actually make the field.
* \remarks The field must NOT be mutated after making is prepared when it is intended to actually
* make the field using the make method of the returned object.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*
* This method might be useful when it is necessary to know the size of the field before making it.
@ -285,7 +285,7 @@ Mp4TagFieldMaker Mp4TagField::prepareMaking(Diagnostics &diag)
* \brief Saves the field to the specified \a stream.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void Mp4TagField::make(ostream &stream, Diagnostics &diag)
@ -436,7 +436,7 @@ void Mp4TagField::reset()
}
/*!
* \class Media::Mp4TagFieldMaker
* \class TagParser::Mp4TagFieldMaker
* \brief The Mp4TagFieldMaker class helps making tag fields.
* It allows to calculate the required size.
* \sa See Mp4TagFieldMaker::prepareMaking() for more information.
@ -564,7 +564,7 @@ Mp4TagFieldMaker::Mp4TagFieldMaker(Mp4TagField &field, Diagnostics &diag)
* specified \a stream.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Assumes the data is already validated and thus does NOT
* throw Media::Failure or a derived exception.
* throw TagParser::Failure or a derived exception.
*/
void Mp4TagFieldMaker::make(ostream &stream)
{

4
mp4/mp4track.cpp
View File

@ -117,8 +117,8 @@ Mpeg4VideoSpecificConfig::Mpeg4VideoSpecificConfig()
*/
/*!
* \class Media::Mp4Track
* \brief Implementation of Media::AbstractTrack for the MP4 container.
* \class TagParser::Mp4Track
* \brief Implementation of TagParser::AbstractTrack for the MP4 container.
*/
/*!

2
mp4/mpeg4descriptor.cpp
View File

@ -12,7 +12,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::Mpeg4Descriptor
* \class TagParser::Mpeg4Descriptor
* \brief The Mpeg4Descriptor class helps to parse MPEG-4 descriptors.
*/

2
mpegaudio/mpegaudioframe.cpp
View File

@ -31,7 +31,7 @@ const char *mpegChannelModeString(MpegChannelMode channelMode)
const uint64 MpegAudioFrame::m_xingHeaderOffset = 0x24;
/*!
* \class Media::MpegAudioFrame
* \class TagParser::MpegAudioFrame
* \brief The MpegAudioFrame class is used to parse MPEG audio frames.
*/

4
mpegaudio/mpegaudioframestream.cpp
View File

@ -13,8 +13,8 @@ using namespace ChronoUtilities;
namespace TagParser {
/*!
* \class Media::MpegAudioFrameStream
* \brief Implementation of Media::AbstractTrack MPEG audio streams.
* \class TagParser::MpegAudioFrameStream
* \brief Implementation of TagParser::AbstractTrack MPEG audio streams.
*/
/*!

8
ogg/oggcontainer.cpp
View File

@ -19,8 +19,8 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::OggVorbisComment
* \brief Specialization of Media::VorbisComment for Vorbis comments inside an OGG stream.
* \class TagParser::OggVorbisComment
* \brief Specialization of TagParser::VorbisComment for Vorbis comments inside an OGG stream.
*/
const char *OggVorbisComment::typeName() const
@ -38,8 +38,8 @@ const char *OggVorbisComment::typeName() const
}
/*!
* \class Media::OggContainer
* \brief Implementation of Media::AbstractContainer for OGG files.
* \class TagParser::OggContainer
* \brief Implementation of TagParser::AbstractContainer for OGG files.
*/
/*!

2
ogg/oggiterator.cpp
View File

@ -13,7 +13,7 @@ using namespace IoUtilities;
namespace TagParser {
/*!
* \class Media::OggIterator
* \class TagParser::OggIterator
* \brief The OggIterator class helps iterating through all segments of an OGG bitstream.
*
* If an OggIterator has just been constructed it is invalid. To fetch the first page from

2
ogg/oggpage.cpp
View File

@ -12,7 +12,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::OggPage
* \class TagParser::OggPage
* \brief The OggPage class is used to parse OGG pages.
* \sa http://www.xiph.org/ogg/doc/framing.html
*/

4
ogg/oggstream.cpp
View File

@ -24,8 +24,8 @@ using namespace ChronoUtilities;
namespace TagParser {
/*!
* \class Media::OggStream
* \brief Implementation of Media::AbstractTrack for OGG streams.
* \class TagParser::OggStream
* \brief Implementation of TagParser::AbstractTrack for OGG streams.
*/
/*!

2
opus/opusidentificationheader.cpp
View File

@ -12,7 +12,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::OpusIdentificationHeader
* \class TagParser::OpusIdentificationHeader
* \brief The OpusIdentificationHeader class is an Opus identification header parser.
* \sa https://wiki.xiph.org/OggOpus
*/

2
positioninset.h
View File

@ -11,7 +11,7 @@
namespace TagParser {
/*!
* \class Media::PositionInSet
* \class TagParser::PositionInSet
* \brief The PositionInSet class describes the position of an element in a
* set which consists of a certain number of elements.
*

2
tag.cpp
View File

@ -5,7 +5,7 @@ using namespace std;
namespace TagParser {
/*!
* \class Media::Tag
* \class TagParser::Tag
* \brief The Tag class is used to store, read and write tag information.
*
* The Tag class only provides the interface and common functionality. It

20
tag.h
View File

@ -19,12 +19,12 @@ namespace TagParser {
*/
enum class TagType : unsigned int {
Unspecified = 0x00, /**< The tag type is unspecified. */
Id3v1Tag = 0x01, /**< The tag is a Media::Id3v1Tag. */
Id3v2Tag = 0x02, /**< The tag is a Media::Id3v2Tag. */
Mp4Tag = 0x04, /**< The tag is a Media::Mp4Tag. */
MatroskaTag = 0x08, /**< The tag is a Media::MatroskaTag. */
VorbisComment = 0x10, /**< The tag is a Media::VorbisComment. */
OggVorbisComment = 0x20 /**< The tag is a Media::OggVorbisComment. */
Id3v1Tag = 0x01, /**< The tag is a TagParser::Id3v1Tag. */
Id3v2Tag = 0x02, /**< The tag is a TagParser::Id3v2Tag. */
Mp4Tag = 0x04, /**< The tag is a TagParser::Mp4Tag. */
MatroskaTag = 0x08, /**< The tag is a TagParser::MatroskaTag. */
VorbisComment = 0x10, /**< The tag is a TagParser::VorbisComment. */
OggVorbisComment = 0x20 /**< The tag is a TagParser::OggVorbisComment. */
};
/*!
@ -70,17 +70,17 @@ enum class KnownField : unsigned int {
};
/*!
* \brief The first valid entry in the Media::KnownField enum.
* \brief The first valid entry in the TagParser::KnownField enum.
*/
constexpr KnownField firstKnownField = KnownField::Title;
/*!
* \brief The last valid entry in the Media::KnownField enum.
* \brief The last valid entry in the TagParser::KnownField enum.
*/
constexpr KnownField lastKnownField = KnownField::Vendor;
/*!
* \brief The number of valid entries in the Media::KnownField enum.
* \brief The number of valid entries in the TagParser::KnownField enum.
*/
constexpr unsigned int knownFieldArraySize = static_cast<unsigned int>(lastKnownField) + 1;
@ -133,7 +133,7 @@ protected:
};
/*!
* \brief Returns the type of the tag as Media::TagType.
* \brief Returns the type of the tag as TagParser::TagType.
*
* This is TagType::Unspecified by default and might be overwritten
* when subclassing.

2
tagtarget.cpp
View File

@ -37,7 +37,7 @@ const char *tagTargetLevelName(TagTargetLevel tagTargetLevel)
}
/*!
* \class Media::TagTarget
* \class TagParser::TagTarget
* \brief The TagTarget class specifies the target of a tag.
*
* Tags might only target a specific track, chapter, ...

4
tagvalue.cpp
View File

@ -46,10 +46,10 @@ const char *tagDataTypeString(TagDataType dataType)
}
/*!
* \class Media::TagValue
* \class TagParser::TagValue
* \brief The TagValue class wraps values of different types. It is meant to be assigned to a tag field.
*
* For a list of supported types see Media::TagDataType.
* For a list of supported types see TagParser::TagDataType.
*/
/*!

2
tagvalue.h
View File

@ -52,7 +52,7 @@ constexpr int characterSize(TagTextEncoding encoding)
enum class TagDataType : unsigned int {
Text, /**< text/string */
Integer, /**< integer */
PositionInSet, /**< position in set, see Media::PositionInSet */
PositionInSet, /**< position in set, see TagParser::PositionInSet */
StandardGenreIndex, /**< pre-defined genre name denoted by numerical code */
TimeSpan, /**< time span, see ChronoUtils::TimeSpan */
DateTime, /**< date time, see ChronoUtils::DateTime */

10
vorbis/vorbiscomment.cpp
View File

@ -20,8 +20,8 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::VorbisComment
* \brief Implementation of Media::Tag for Vorbis comments.
* \class TagParser::VorbisComment
* \brief Implementation of TagParser::Tag for Vorbis comments.
*/
const TagValue &VorbisComment::value(KnownField field) const
@ -172,7 +172,7 @@ template <class StreamType> void VorbisComment::internalParse(StreamType &stream
* \brief Parses tag information using the specified OGG \a iterator.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void VorbisComment::parse(OggIterator &iterator, VorbisCommentFlags flags, Diagnostics &diag)
@ -184,7 +184,7 @@ void VorbisComment::parse(OggIterator &iterator, VorbisCommentFlags flags, Diagn
* \brief Parses tag information using the specified OGG \a iterator.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void VorbisComment::parse(istream &stream, uint64 maxSize, VorbisCommentFlags flags, Diagnostics &diag)
@ -196,7 +196,7 @@ void VorbisComment::parse(istream &stream, uint64 maxSize, VorbisCommentFlags fl
* \brief Writes tag information to the specified \a stream.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
*/
void VorbisComment::make(std::ostream &stream, VorbisCommentFlags flags, Diagnostics &diag)

10
vorbis/vorbiscommentfield.cpp
View File

@ -26,7 +26,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::VorbisCommentField
* \class TagParser::VorbisCommentField
* \brief The VorbisCommentField class is used by VorbisComment to store the fields.
*/
@ -113,7 +113,7 @@ template <class StreamType> void VorbisCommentField::internalParse(StreamType &s
* at the beginning of the field to be parsed.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void VorbisCommentField::parse(OggIterator &iterator, Diagnostics &diag)
@ -129,7 +129,7 @@ void VorbisCommentField::parse(OggIterator &iterator, Diagnostics &diag)
* at the beginning of the field to be parsed.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void VorbisCommentField::parse(OggIterator &iterator, uint64 &maxSize, Diagnostics &diag)
@ -144,7 +144,7 @@ void VorbisCommentField::parse(OggIterator &iterator, uint64 &maxSize, Diagnosti
* at the beginning of the field to be parsed.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a parsing
* \throws Throws TagParser::Failure or a derived exception when a parsing
* error occurs.
*/
void VorbisCommentField::parse(istream &stream, uint64 &maxSize, Diagnostics &diag)
@ -156,7 +156,7 @@ void VorbisCommentField::parse(istream &stream, uint64 &maxSize, Diagnostics &di
* \brief Writes the field to a stream using the specified \a writer.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* \throws Throws TagParser::Failure or a derived exception when a making
* error occurs.
* \returns Returns whether the field has been written. (Some fields might be skipped
* when specific \a flags are set.)

2
vorbis/vorbisidentificationheader.cpp
View File

@ -13,7 +13,7 @@ using namespace ConversionUtilities;
namespace TagParser {
/*!
* \class Media::VorbisIdentificationHeader
* \class TagParser::VorbisIdentificationHeader
* \brief The VorbisIdentificationHeader class is a Vorbis identification header parser.
*/

6
wav/waveaudiostream.cpp
View File

@ -14,7 +14,7 @@ using namespace ChronoUtilities;
namespace TagParser {
/*!
* \class Media::WaveFormatHeader
* \class TagParser::WaveFormatHeader
* \brief The WaveFormatHeader class parses the WAVEFORMATEX structure defined by MS.
*/
@ -63,8 +63,8 @@ MediaFormat WaveFormatHeader::format() const
}
/*!
* \class Media::WaveAudioStream
* \brief Implementation of Media::AbstractTrack for the
* \class TagParser::WaveAudioStream
* \brief Implementation of TagParser::AbstractTrack for the
* RIFF WAVE container format.
*/