Skip to content

Commit 36be050

Browse files
uklotzdeSerial-ATA
authored andcommitted
Add doc comments to ItemKey
1 parent 15ded5a commit 36be050

File tree

1 file changed

+54
-9
lines changed

1 file changed

+54
-9
lines changed

src/tag/item.rs

Lines changed: 54 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,11 @@ macro_rules! gen_item_keys {
413413
),+
414414
];
415415
KEYS => [
416-
$($variant:ident),+ $(,)?
416+
$(
417+
$(#[$variant_meta:meta])*
418+
$variant_ident:ident
419+
),+
420+
$(,)?
417421
]
418422
) => {
419423
#[derive(PartialEq, Clone, Debug, Eq, Hash)]
@@ -422,7 +426,8 @@ macro_rules! gen_item_keys {
422426
/// A generic representation of a tag's key
423427
pub enum ItemKey {
424428
$(
425-
$variant,
429+
$(#[$variant_meta])*
430+
$variant_ident,
426431
)+
427432
/// When a key couldn't be mapped to another variant
428433
///
@@ -551,21 +556,61 @@ gen_item_keys!(
551556
Movement,
552557
MovementNumber,
553558
MovementTotal,
554-
// MusicBrainz Recording ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id21>
559+
560+
///////////////////////////////////////////////////////////////
561+
// MusicBrainz Identfiers
562+
563+
/// MusicBrainz Recording ID
564+
///
565+
/// Textual representation of the UUID.
566+
///
567+
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id21>
555568
MusicBrainzRecordingId,
556-
// MusicBrainz Track ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id24>
569+
570+
/// MusicBrainz Track ID
571+
///
572+
/// Textual representation of the UUID.
573+
///
574+
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id24>
557575
MusicBrainzTrackId,
558-
// MusicBrainz Release ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id23>
576+
577+
/// MusicBrainz Release ID
578+
///
579+
/// Textual representation of the UUID.
580+
///
581+
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id23>
559582
MusicBrainzReleaseId,
560-
// MusicBrainz Release Group ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#musicbrainz-release-group-id>
583+
584+
/// MusicBrainz Release Group ID
585+
///
586+
/// Textual representation of the UUID.
587+
///
588+
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#musicbrainz-release-group-id>
561589
MusicBrainzReleaseGroupId,
562-
// MusicBrainz Artist ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id17>
590+
591+
/// MusicBrainz Artist ID
592+
///
593+
/// Textual representation of the UUID.
594+
///
595+
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id17>
563596
MusicBrainzArtistId,
564-
// MusicBrainz Release Artist ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id22>
597+
598+
/// MusicBrainz Release Artist ID
599+
///
600+
/// Textual representation of the UUID.
601+
///
602+
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#id22>
565603
MusicBrainzReleaseArtistId,
566-
// MusicBrainz Work ID: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#musicbrainz-work-id>
604+
605+
/// MusicBrainz Work ID
606+
///
607+
/// Textual representation of the UUID.
608+
///
609+
/// Reference: <https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#musicbrainz-work-id>
567610
MusicBrainzWorkId,
568611

612+
///////////////////////////////////////////////////////////////
613+
569614
// Flags
570615
FlagCompilation,
571616
FlagPodcast,

0 commit comments

Comments
 (0)