Skip to content

Commit

Permalink
Add doc comments to ItemKey
Browse files Browse the repository at this point in the history
  • Loading branch information
uklotzde authored and Serial-ATA committed Jul 22, 2023
1 parent 15ded5a commit 36be050
Showing 1 changed file with 54 additions and 9 deletions.
63 changes: 54 additions & 9 deletions src/tag/item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,11 @@ macro_rules! gen_item_keys {
),+
];
KEYS => [
$($variant:ident),+ $(,)?
$(
$(#[$variant_meta:meta])*
$variant_ident:ident
),+
$(,)?
]
) => {
#[derive(PartialEq, Clone, Debug, Eq, Hash)]
Expand All @@ -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
///
Expand Down Expand Up @@ -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,
Expand Down

0 comments on commit 36be050

Please sign in to comment.