Add doc comments to ItemKey

This commit is contained in:
Uwe Klotz 2023-07-22 11:05:26 +02:00 committed by Alex
parent 15ded5a3d4
commit 36be050059

View file

@ -413,7 +413,11 @@ macro_rules! gen_item_keys {
),+
];
KEYS => [
$($variant:ident),+ $(,)?
$(
$(#[$variant_meta:meta])*
$variant_ident:ident
),+
$(,)?
]
) => {
#[derive(PartialEq, Clone, Debug, Eq, Hash)]
@ -422,7 +426,8 @@ macro_rules! gen_item_keys {
/// A generic representation of a tag's key
pub enum ItemKey {
$(
$variant,
$(#[$variant_meta])*
$variant_ident,
)+
/// When a key couldn't be mapped to another variant
///
@ -551,21 +556,61 @@ gen_item_keys!(
Movement,
MovementNumber,
MovementTotal,
// MusicBrainz Recording ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id21>
///////////////////////////////////////////////////////////////
// MusicBrainz Identfiers
/// MusicBrainz Recording ID
///
/// Textual representation of the UUID.
///
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id21>
MusicBrainzRecordingId,
// MusicBrainz Track ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id24>
/// MusicBrainz Track ID
///
/// Textual representation of the UUID.
///
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id24>
MusicBrainzTrackId,
// MusicBrainz Release ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id23>
/// MusicBrainz Release ID
///
/// Textual representation of the UUID.
///
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id23>
MusicBrainzReleaseId,
// MusicBrainz Release Group ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#musicbrainz-release-group-id>
/// MusicBrainz Release Group ID
///
/// Textual representation of the UUID.
///
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#musicbrainz-release-group-id>
MusicBrainzReleaseGroupId,
// MusicBrainz Artist ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id17>
/// MusicBrainz Artist ID
///
/// Textual representation of the UUID.
///
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id17>
MusicBrainzArtistId,
// MusicBrainz Release Artist ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id22>
/// MusicBrainz Release Artist ID
///
/// Textual representation of the UUID.
///
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id22>
MusicBrainzReleaseArtistId,
// MusicBrainz Work ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#musicbrainz-work-id>
/// MusicBrainz Work ID
///
/// Textual representation of the UUID.
///
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#musicbrainz-work-id>
MusicBrainzWorkId,
///////////////////////////////////////////////////////////////
// Flags
FlagCompilation,
FlagPodcast,