From 708de94fdefb59e917b9a8e2d6edc08d296c7691 Mon Sep 17 00:00:00 2001 From: Barrett17 Date: Thu, 27 Dec 2018 15:15:25 +0100 Subject: [PATCH] MetaData: Add doxygen brief --- headers/os/codec/MetaData.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/headers/os/codec/MetaData.h b/headers/os/codec/MetaData.h index 6d2753e18f..3ec9e04748 100644 --- a/headers/os/codec/MetaData.h +++ b/headers/os/codec/MetaData.h @@ -87,6 +87,15 @@ extern const char* kProgramData; // BMetaData // https://wiki.multimedia.cx/index.php?title=FFmpeg_Metadata +/** + * @brief BMetaData stores the media metadata. + * + * The metadata model is sparse and each key can occur at most once, + * except for BMetaData itself. + * The key is an integer and the value is the actual metadata. + * The client of this class is required to know in advance the type + * of a particular metadata key. + */ class BMetaData { public: BMetaData();