From e7ce9e7ceda8ff33765308421e3a45196bec6e39 Mon Sep 17 00:00:00 2001 From: Martchus Date: Thu, 5 Nov 2020 19:52:09 +0100 Subject: [PATCH] Improve documentation --- CMakeLists.txt | 2 +- exceptions.cpp | 2 +- id3/id3v2frame.cpp | 2 ++ matroska/matroskatagid.cpp | 11 +++++++++-- matroska/matroskatagid.h | 4 ---- 5 files changed, 13 insertions(+), 8 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 84f110b..266b386 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -10,7 +10,7 @@ set(META_APP_URL "https://github.com/${META_APP_AUTHOR}/${META_PROJECT_NAME}") set(META_APP_DESCRIPTION "C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags") set(META_VERSION_MAJOR 9) set(META_VERSION_MINOR 3) -set(META_VERSION_PATCH 0) +set(META_VERSION_PATCH 1) set(META_REQUIRED_CPP_UNIT_VERSION 1.14.0) set(META_ADD_DEFAULT_CPP_UNIT_TEST_APPLICATION ON) diff --git a/exceptions.cpp b/exceptions.cpp index 173d00b..6117dfa 100644 --- a/exceptions.cpp +++ b/exceptions.cpp @@ -90,7 +90,7 @@ const char *InvalidDataException::what() const noexcept } /*! - * \class TagParser::NoDataException + * \class TagParser::NoDataProvidedException * \brief The exception that is thrown when the value to be written is empty but that * is not allowed in that context (e.g. an empty ID3v2 frame is not allowed). */ diff --git a/id3/id3v2frame.cpp b/id3/id3v2frame.cpp index 069a481..9f85d5e 100644 --- a/id3/id3v2frame.cpp +++ b/id3/id3v2frame.cpp @@ -20,9 +20,11 @@ using namespace std; using namespace CppUtilities; namespace TagParser { +/// \cond namespace Id3v2TextEncodingBytes { enum Id3v2TextEncodingByte : std::uint8_t { Ascii, Utf16WithBom, Utf16BigEndianWithoutBom, Utf8 }; } +/// \endcond /// \brief The maximum (supported) size of an ID3v2Frame. constexpr auto maxId3v2FrameDataSize(numeric_limits::max() - 15); diff --git a/matroska/matroskatagid.cpp b/matroska/matroskatagid.cpp index 71cd30a..6a5c53a 100644 --- a/matroska/matroskatagid.cpp +++ b/matroska/matroskatagid.cpp @@ -2,13 +2,20 @@ using namespace std; +namespace TagParser { + /*! * \brief Encapsulates Matroska tag IDs. * \sa See https://matroska.org/technical/specs/tagging/index.html for a complete list of the officially supported Matroska tag names. */ -namespace TagParser { - namespace MatroskaTagIds { + +/*! + * \brief Encapsulates track-specific Matroska tag IDs written by mkvmerge 7.0.0 or newer. + * \sa https://github.com/mbunkus/mkvtoolnix/wiki/Automatic-tag-generation + */ +namespace TrackSpecific { +} } } // namespace TagParser diff --git a/matroska/matroskatagid.h b/matroska/matroskatagid.h index 835d943..db69750 100644 --- a/matroska/matroskatagid.h +++ b/matroska/matroskatagid.h @@ -439,10 +439,6 @@ constexpr TAG_PARSER_EXPORT const char *termsOfUse() return "TERMS_OF_USE"; } -/*! - * \brief Encapsulates track-specific Matroska tag IDs written by mkvmerge 7.0.0 or newer. - * \sa https://github.com/mbunkus/mkvtoolnix/wiki/Automatic-tag-generation - */ namespace TrackSpecific { constexpr TAG_PARSER_EXPORT const char *numberOfBytes() {