fix(forge doc): display custom natspec tag (foundry-rs#9257)

fix(forge doc): display custom natspec tag
rplusq · Nov 29, 2024 · 587897d · 587897d
1 parent b4152d0
commit 587897d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/crates/doc/src/parser/comment.rs b/crates/doc/src/parser/comment.rs
@@ -1,10 +1,10 @@
 use alloy_primitives::map::HashMap;
-use derive_more::{Deref, DerefMut};
+use derive_more::{derive::Display, Deref, DerefMut};
 use solang_parser::doccomment::DocCommentTag;
 
 /// The natspec comment tag explaining the purpose of the comment.
 /// See: <https://docs.soliditylang.org/en/v0.8.17/natspec-format.html#tags>.
-#[derive(Clone, Debug, PartialEq, Eq)]
+#[derive(Clone, Debug, Display, PartialEq, Eq)]
 pub enum CommentTag {
     /// A title that should describe the contract/interface
     Title,

diff --git a/crates/doc/src/writer/as_doc.rs b/crates/doc/src/writer/as_doc.rs
@@ -64,8 +64,9 @@ impl AsDoc for CommentsRef<'_> {
             writer.write_bold(&format!("Note{}:", if customs.len() == 1 { "" } else { "s" }))?;
             for c in customs.iter() {
                 writer.writeln_raw(format!(
-                    "{}{}",
+                    "{}{}: {}",
                     if customs.len() == 1 { "" } else { "- " },
+                    &c.tag,
                     &c.value
                 ))?;
                 writer.writeln()?;