Improve documentation

This commit is contained in:
Martchus 2020-11-05 19:52:09 +01:00
parent 2cdcb9e6b2
commit e7ce9e7ced
5 changed files with 13 additions and 8 deletions

View File

@ -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_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_MAJOR 9)
set(META_VERSION_MINOR 3) 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_REQUIRED_CPP_UNIT_VERSION 1.14.0)
set(META_ADD_DEFAULT_CPP_UNIT_TEST_APPLICATION ON) set(META_ADD_DEFAULT_CPP_UNIT_TEST_APPLICATION ON)

View File

@ -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 * \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). * is not allowed in that context (e.g. an empty ID3v2 frame is not allowed).
*/ */

View File

@ -20,9 +20,11 @@ using namespace std;
using namespace CppUtilities; using namespace CppUtilities;
namespace TagParser { namespace TagParser {
/// \cond
namespace Id3v2TextEncodingBytes { namespace Id3v2TextEncodingBytes {
enum Id3v2TextEncodingByte : std::uint8_t { Ascii, Utf16WithBom, Utf16BigEndianWithoutBom, Utf8 }; enum Id3v2TextEncodingByte : std::uint8_t { Ascii, Utf16WithBom, Utf16BigEndianWithoutBom, Utf8 };
} }
/// \endcond
/// \brief The maximum (supported) size of an ID3v2Frame. /// \brief The maximum (supported) size of an ID3v2Frame.
constexpr auto maxId3v2FrameDataSize(numeric_limits<std::uint32_t>::max() - 15); constexpr auto maxId3v2FrameDataSize(numeric_limits<std::uint32_t>::max() - 15);

View File

@ -2,13 +2,20 @@
using namespace std; using namespace std;
namespace TagParser {
/*! /*!
* \brief Encapsulates Matroska tag IDs. * \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. * \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 { 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 } // namespace TagParser

View File

@ -439,10 +439,6 @@ constexpr TAG_PARSER_EXPORT const char *termsOfUse()
return "TERMS_OF_USE"; 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 { namespace TrackSpecific {
constexpr TAG_PARSER_EXPORT const char *numberOfBytes() constexpr TAG_PARSER_EXPORT const char *numberOfBytes()
{ {