From 3265e0bea486f2a45cbb9ccf34cbfc8d8b60435f Mon Sep 17 00:00:00 2001 From: Martchus Date: Sun, 3 Jun 2018 20:38:32 +0200 Subject: [PATCH] Fix documentation which was still using the old namespace --- aac/aacframe.cpp | 2 +- abstractattachment.cpp | 8 ++++---- abstractchapter.cpp | 2 +- abstractcontainer.cpp | 8 ++++---- abstracttrack.cpp | 6 +++--- abstracttrack.h | 14 +++++++------- adts/adtsframe.cpp | 2 +- adts/adtsframe.h | 8 ++++---- adts/adtsstream.cpp | 4 ++-- aspectratio.cpp | 2 +- avc/avcinfo.cpp | 12 ++++++------ avi/bitmapinfoheader.cpp | 2 +- backuphelper.cpp | 2 +- basicfileinfo.cpp | 7 ++----- exceptions.cpp | 14 +++++++------- fieldbasedtag.h | 4 ++-- flac/flacmetadata.cpp | 6 +++--- flac/flacstream.cpp | 4 ++-- flac/flactooggmappingheader.cpp | 2 +- genericcontainer.h | 4 ++-- genericfileelement.h | 12 ++++++------ generictagfield.h | 2 +- id3/id3v1tag.cpp | 8 ++++---- id3/id3v2frame.cpp | 12 ++++++------ id3/id3v2tag.cpp | 16 ++++++++-------- matroska/ebmlelement.cpp | 2 +- matroska/matroskaattachment.cpp | 12 ++++++------ matroska/matroskaattachment.h | 2 +- matroska/matroskacontainer.cpp | 4 ++-- matroska/matroskacues.cpp | 2 +- matroska/matroskaseekinfo.cpp | 2 +- matroska/matroskatag.cpp | 16 ++++++++-------- matroska/matroskatagfield.cpp | 12 ++++++------ matroska/matroskatrack.cpp | 8 ++++---- matroska/matroskatrack.h | 4 ++-- mediafileinfo.cpp | 14 +++++++------- mediaformat.cpp | 2 +- mp4/mp4atom.cpp | 2 +- mp4/mp4container.cpp | 4 ++-- mp4/mp4ids.cpp | 2 +- mp4/mp4tag.cpp | 16 ++++++++-------- mp4/mp4tagfield.cpp | 12 ++++++------ mp4/mp4track.cpp | 4 ++-- mp4/mpeg4descriptor.cpp | 2 +- mpegaudio/mpegaudioframe.cpp | 2 +- mpegaudio/mpegaudioframestream.cpp | 4 ++-- ogg/oggcontainer.cpp | 8 ++++---- ogg/oggiterator.cpp | 2 +- ogg/oggpage.cpp | 2 +- ogg/oggstream.cpp | 4 ++-- opus/opusidentificationheader.cpp | 2 +- positioninset.h | 2 +- tag.cpp | 2 +- tag.h | 20 ++++++++++---------- tagtarget.cpp | 2 +- tagvalue.cpp | 4 ++-- tagvalue.h | 2 +- vorbis/vorbiscomment.cpp | 10 +++++----- vorbis/vorbiscommentfield.cpp | 10 +++++----- vorbis/vorbisidentificationheader.cpp | 2 +- wav/waveaudiostream.cpp | 6 +++--- 61 files changed, 183 insertions(+), 186 deletions(-) diff --git a/aac/aacframe.cpp b/aac/aacframe.cpp index eced3f6..0514218 100644 --- a/aac/aacframe.cpp +++ b/aac/aacframe.cpp @@ -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. diff --git a/abstractattachment.cpp b/abstractattachment.cpp index 436c70d..f31ea2e 100644 --- a/abstractattachment.cpp +++ b/abstractattachment.cpp @@ -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. diff --git a/abstractchapter.cpp b/abstractchapter.cpp index 9b58525..290ca2a 100644 --- a/abstractchapter.cpp +++ b/abstractchapter.cpp @@ -8,7 +8,7 @@ using namespace ChronoUtilities; namespace TagParser { /*! - * \class Media::AbstractChapter + * \class TagParser::AbstractChapter * \brief The AbstractChapter class parses chapter information. */ diff --git a/abstractcontainer.cpp b/abstractcontainer.cpp index c825a91..a9e68e6 100644 --- a/abstractcontainer.cpp +++ b/abstractcontainer.cpp @@ -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) diff --git a/abstracttrack.cpp b/abstracttrack.cpp index b3c4dff..477abc7 100644 --- a/abstracttrack.cpp +++ b/abstracttrack.cpp @@ -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. */ diff --git a/abstracttrack.h b/abstracttrack.h index 78c8312..191854e 100644 --- a/abstracttrack.h +++ b/abstracttrack.h @@ -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 { diff --git a/adts/adtsframe.cpp b/adts/adtsframe.cpp index 12199cb..68d45d8 100644 --- a/adts/adtsframe.cpp +++ b/adts/adtsframe.cpp @@ -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. */ diff --git a/adts/adtsframe.h b/adts/adtsframe.h index 60f7909..ef83668 100644 --- a/adts/adtsframe.h +++ b/adts/adtsframe.h @@ -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 { diff --git a/adts/adtsstream.cpp b/adts/adtsstream.cpp index ccf2fda..07675b6 100644 --- a/adts/adtsstream.cpp +++ b/adts/adtsstream.cpp @@ -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) diff --git a/aspectratio.cpp b/aspectratio.cpp index 1c5ec93..5b8e7fb 100644 --- a/aspectratio.cpp +++ b/aspectratio.cpp @@ -5,7 +5,7 @@ using namespace std; namespace TagParser { /*! - * \struct Media::AspectRatio + * \struct TagParser::AspectRatio * \brief The AspectRatio struct defines an aspect ratio. */ diff --git a/avc/avcinfo.cpp b/avc/avcinfo.cpp index a2cce9d..610f131 100644 --- a/avc/avcinfo.cpp +++ b/avc/avcinfo.cpp @@ -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 */ diff --git a/avi/bitmapinfoheader.cpp b/avi/bitmapinfoheader.cpp index d340375..f7d30db 100644 --- a/avi/bitmapinfoheader.cpp +++ b/avi/bitmapinfoheader.cpp @@ -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. */ diff --git a/backuphelper.cpp b/backuphelper.cpp index 5681915..85c3b81 100644 --- a/backuphelper.cpp +++ b/backuphelper.cpp @@ -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. * diff --git a/basicfileinfo.cpp b/basicfileinfo.cpp index 57d072e..2af742e 100644 --- a/basicfileinfo.cpp +++ b/basicfileinfo.cpp @@ -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. * diff --git a/exceptions.cpp b/exceptions.cpp index 4de6d46..5492daf 100644 --- a/exceptions.cpp +++ b/exceptions.cpp @@ -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. */ diff --git a/fieldbasedtag.h b/fieldbasedtag.h index 6d6811f..26a73c8 100644 --- a/fieldbasedtag.h +++ b/fieldbasedtag.h @@ -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 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. * diff --git a/flac/flacmetadata.cpp b/flac/flacmetadata.cpp index 5661600..d2b1b01 100644 --- a/flac/flacmetadata.cpp +++ b/flac/flacmetadata.cpp @@ -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 */ diff --git a/flac/flacstream.cpp b/flac/flacstream.cpp index 0efd098..1f0f28a 100644 --- a/flac/flacstream.cpp +++ b/flac/flacstream.cpp @@ -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. */ /*! diff --git a/flac/flactooggmappingheader.cpp b/flac/flactooggmappingheader.cpp index 2d6aa48..af0b03a 100644 --- a/flac/flactooggmappingheader.cpp +++ b/flac/flactooggmappingheader.cpp @@ -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 */ diff --git a/genericcontainer.h b/genericcontainer.h index 0ac43ba..9dca4c7 100644 --- a/genericcontainer.h +++ b/genericcontainer.h @@ -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. diff --git a/genericfileelement.h b/genericfileelement.h index 13d8629..b71215f 100644 --- a/genericfileelement.h +++ b/genericfileelement.h @@ -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 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 void GenericFileElement: * 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 void GenericFileElement::parse(Diagnostics &diag) @@ -787,7 +787,7 @@ template void GenericFileElement: * 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 void GenericFileElement: * 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 constexpr byte GenericFileElement 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. diff --git a/id3/id3v1tag.cpp b/id3/id3v1tag.cpp index f3fc347..4276b1e 100644 --- a/id3/id3v1tag.cpp +++ b/id3/id3v1tag.cpp @@ -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) diff --git a/id3/id3v2frame.cpp b/id3/id3v2frame.cpp index a7c47f7..a553d77 100644 --- a/id3/id3v2frame.cpp +++ b/id3/id3v2frame.cpp @@ -29,7 +29,7 @@ enum Id3v2TextEncodingByte : byte { Ascii, Utf16WithBom, Utf16BigEndianWithoutBo constexpr auto maxId3v2FrameDataSize(numeric_limits::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 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) { diff --git a/id3/id3v2tag.cpp b/id3/id3v2tag.cpp index 49e595f..a1b764a 100644 --- a/id3/id3v2tag.cpp +++ b/id3/id3v2tag.cpp @@ -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) { diff --git a/matroska/ebmlelement.cpp b/matroska/ebmlelement.cpp index 5ed712b..6a404f2 100644 --- a/matroska/ebmlelement.cpp +++ b/matroska/ebmlelement.cpp @@ -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. */ diff --git a/matroska/matroskaattachment.cpp b/matroska/matroskaattachment.cpp index 63a9baf..a1cd95c 100644 --- a/matroska/matroskaattachment.cpp +++ b/matroska/matroskaattachment.cpp @@ -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 { diff --git a/matroska/matroskaattachment.h b/matroska/matroskaattachment.h index f259d26..d1b729c 100644 --- a/matroska/matroskaattachment.h +++ b/matroska/matroskaattachment.h @@ -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() diff --git a/matroska/matroskacontainer.cpp b/matroska/matroskacontainer.cpp index ab4d307..800d4d4 100644 --- a/matroska/matroskacontainer.cpp +++ b/matroska/matroskacontainer.cpp @@ -34,7 +34,7 @@ using namespace ChronoUtilities; namespace TagParser { /*! - * \class Media::MatroskaContainer + * \class TagParser::MatroskaContainer * \brief Implementation of GenericContainer. */ @@ -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) diff --git a/matroska/matroskacues.cpp b/matroska/matroskacues.cpp index 5403cf5..2560441 100644 --- a/matroska/matroskacues.cpp +++ b/matroska/matroskacues.cpp @@ -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. diff --git a/matroska/matroskaseekinfo.cpp b/matroska/matroskaseekinfo.cpp index 189ae5c..c5669dc 100644 --- a/matroska/matroskaseekinfo.cpp +++ b/matroska/matroskaseekinfo.cpp @@ -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. */ diff --git a/matroska/matroskatag.cpp b/matroska/matroskatag.cpp index fc8bbfb..85e2a59 100644 --- a/matroska/matroskatag.cpp +++ b/matroska/matroskatag.cpp @@ -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 { diff --git a/matroska/matroskatagfield.cpp b/matroska/matroskatagfield.cpp index 07848e8..df5033b 100644 --- a/matroska/matroskatagfield.cpp +++ b/matroska/matroskatagfield.cpp @@ -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 { diff --git a/matroska/matroskatrack.cpp b/matroska/matroskatrack.cpp index f96be62..0b086bb 100644 --- a/matroska/matroskatrack.cpp +++ b/matroska/matroskatrack.cpp @@ -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 { diff --git a/matroska/matroskatrack.h b/matroska/matroskatrack.h index a0a22a3..30a05cf 100644 --- a/matroska/matroskatrack.h +++ b/matroska/matroskatrack.h @@ -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. diff --git a/mediafileinfo.cpp b/mediafileinfo.cpp index 438dec3..0e7c117 100644 --- a/mediafileinfo.cpp +++ b/mediafileinfo.cpp @@ -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 diff --git a/mediaformat.cpp b/mediaformat.cpp index 11877c8..c22ab59 100644 --- a/mediaformat.cpp +++ b/mediaformat.cpp @@ -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. */ diff --git a/mp4/mp4atom.cpp b/mp4/mp4atom.cpp index fdbe1f8..fd064ac 100644 --- a/mp4/mp4atom.cpp +++ b/mp4/mp4atom.cpp @@ -20,7 +20,7 @@ using namespace ConversionUtilities; namespace TagParser { /*! - * \class Media::Mp4Atom + * \class TagParser::Mp4Atom * \brief The Mp4Atom class helps to parse MP4 files. */ diff --git a/mp4/mp4container.cpp b/mp4/mp4container.cpp index f6e4665..7120570 100644 --- a/mp4/mp4container.cpp +++ b/mp4/mp4container.cpp @@ -25,7 +25,7 @@ using namespace ChronoUtilities; namespace TagParser { /*! - * \class Media::Mp4Container + * \class TagParser::Mp4Container * \brief Implementation of GenericContainer. */ @@ -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 &oldMdatOffsets, const std::vector &newMdatOffsets, Diagnostics &diag) diff --git a/mp4/mp4ids.cpp b/mp4/mp4ids.cpp index 82e3e4a..ff7d908 100644 --- a/mp4/mp4ids.cpp +++ b/mp4/mp4ids.cpp @@ -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) { diff --git a/mp4/mp4tag.cpp b/mp4/mp4tag.cpp index 64b1366..5723491 100644 --- a/mp4/mp4tag.cpp +++ b/mp4/mp4tag.cpp @@ -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) { diff --git a/mp4/mp4tagfield.cpp b/mp4/mp4tagfield.cpp index 8f36d87..978c72f 100644 --- a/mp4/mp4tagfield.cpp +++ b/mp4/mp4tagfield.cpp @@ -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) { diff --git a/mp4/mp4track.cpp b/mp4/mp4track.cpp index a4b89bd..83c3d9e 100644 --- a/mp4/mp4track.cpp +++ b/mp4/mp4track.cpp @@ -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. */ /*! diff --git a/mp4/mpeg4descriptor.cpp b/mp4/mpeg4descriptor.cpp index 57549fe..a351151 100644 --- a/mp4/mpeg4descriptor.cpp +++ b/mp4/mpeg4descriptor.cpp @@ -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. */ diff --git a/mpegaudio/mpegaudioframe.cpp b/mpegaudio/mpegaudioframe.cpp index a98f313..1fbaa84 100644 --- a/mpegaudio/mpegaudioframe.cpp +++ b/mpegaudio/mpegaudioframe.cpp @@ -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. */ diff --git a/mpegaudio/mpegaudioframestream.cpp b/mpegaudio/mpegaudioframestream.cpp index 8c65966..07c19e7 100644 --- a/mpegaudio/mpegaudioframestream.cpp +++ b/mpegaudio/mpegaudioframestream.cpp @@ -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. */ /*! diff --git a/ogg/oggcontainer.cpp b/ogg/oggcontainer.cpp index 424cce4..d15f431 100644 --- a/ogg/oggcontainer.cpp +++ b/ogg/oggcontainer.cpp @@ -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. */ /*! diff --git a/ogg/oggiterator.cpp b/ogg/oggiterator.cpp index 9b1261c..c9354c4 100644 --- a/ogg/oggiterator.cpp +++ b/ogg/oggiterator.cpp @@ -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 diff --git a/ogg/oggpage.cpp b/ogg/oggpage.cpp index 96e4375..58d8499 100644 --- a/ogg/oggpage.cpp +++ b/ogg/oggpage.cpp @@ -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 */ diff --git a/ogg/oggstream.cpp b/ogg/oggstream.cpp index 028ab7c..78da9d1 100644 --- a/ogg/oggstream.cpp +++ b/ogg/oggstream.cpp @@ -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. */ /*! diff --git a/opus/opusidentificationheader.cpp b/opus/opusidentificationheader.cpp index 2cc239b..651ab7b 100644 --- a/opus/opusidentificationheader.cpp +++ b/opus/opusidentificationheader.cpp @@ -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 */ diff --git a/positioninset.h b/positioninset.h index 15b7ef8..2db0bdc 100644 --- a/positioninset.h +++ b/positioninset.h @@ -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. * diff --git a/tag.cpp b/tag.cpp index 36d8cf1..0477068 100644 --- a/tag.cpp +++ b/tag.cpp @@ -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 diff --git a/tag.h b/tag.h index 6a8ed3c..11edbdd 100644 --- a/tag.h +++ b/tag.h @@ -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(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. diff --git a/tagtarget.cpp b/tagtarget.cpp index 42fe12a..d1b45e3 100644 --- a/tagtarget.cpp +++ b/tagtarget.cpp @@ -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, ... diff --git a/tagvalue.cpp b/tagvalue.cpp index 14057a8..db3cb03 100644 --- a/tagvalue.cpp +++ b/tagvalue.cpp @@ -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. */ /*! diff --git a/tagvalue.h b/tagvalue.h index 0188c95..30e4b9f 100644 --- a/tagvalue.h +++ b/tagvalue.h @@ -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 */ diff --git a/vorbis/vorbiscomment.cpp b/vorbis/vorbiscomment.cpp index 516eb0e..c8eb048 100644 --- a/vorbis/vorbiscomment.cpp +++ b/vorbis/vorbiscomment.cpp @@ -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 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) diff --git a/vorbis/vorbiscommentfield.cpp b/vorbis/vorbiscommentfield.cpp index 21769bb..00dccc2 100644 --- a/vorbis/vorbiscommentfield.cpp +++ b/vorbis/vorbiscommentfield.cpp @@ -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 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.) diff --git a/vorbis/vorbisidentificationheader.cpp b/vorbis/vorbisidentificationheader.cpp index d10e22a..7392fa5 100644 --- a/vorbis/vorbisidentificationheader.cpp +++ b/vorbis/vorbisidentificationheader.cpp @@ -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. */ diff --git a/wav/waveaudiostream.cpp b/wav/waveaudiostream.cpp index 181262a..9dfa0a7 100644 --- a/wav/waveaudiostream.cpp +++ b/wav/waveaudiostream.cpp @@ -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. */