Merge pull request #3007 from veryl-lang/feat/component-doc

feat(doc): refine generated component pages

Author: dalance

crates/component/macros/src/lib.rs

@@ -343,7 +343,7 @@ fn expand_derive(input: DeriveInput) -> syn::Result<TokenStream2> {
     let mut has_clock_port = false;
     // #[interface] fields, spliced into the manifest by const
     // concatenation.
-    let mut groups: Vec<(String, Type)> = Vec::new();
+    let mut groups: Vec<(String, Type, Option<String>)> = Vec::new();
     // Port and group names share the connection-item namespace, so
     // duplicates are rejected here where both declarations are visible.
     let mut port_names: std::collections::HashSet<String> = std::collections::HashSet::new();
@@ -378,7 +378,7 @@ fn expand_derive(input: DeriveInput) -> syn::Result<TokenStream2> {
             let ty = field.ty.clone();
             inits.push(quote!(#field_ident:
                 <#ty as ::veryl_component::VerylInterface>::resolve(ctx, #group)?));
-            groups.push((group, ty));
+            groups.push((group, ty, doc));
             continue;
         }
 
@@ -502,11 +502,14 @@ fn expand_derive(input: DeriveInput) -> syn::Result<TokenStream2> {
     // Splicing another type's consts needs const concatenation; a component
     // without interface fields keeps the plain literal.
     let mut decl_parts: Vec<TokenStream2> = vec![quote!(#decl_prefix)];
-    for (i, (group, ty)) in groups.iter().enumerate() {
+    for (i, (group, ty, doc)) in groups.iter().enumerate() {
         let head = format!(
-            r#"{}{{"name":"{}","interface":""#,
+            r#"{}{{"name":"{}"{}"interface":""#,
             if i == 0 { "" } else { "," },
             json_escape(group),
+            doc.as_ref()
+                .map(|d| format!(r#","doc":"{}","#, json_escape(d)))
+                .unwrap_or_else(|| ",".to_string()),
         );
         decl_parts.push(quote!(#head));
         decl_parts.push(quote!(<#ty as ::veryl_component::VerylInterface>::INTERFACE_PATH));

crates/languageserver/src/server.rs

@@ -1647,6 +1647,7 @@ mod tests {
                     doc: None,
                 },
             ],
+            doc: None,
         });
         let text = component_new_text("$comp::x", Some(&grouped));
         assert_eq!(text, "$comp::x (clk, q, axi: , );");

crates/metadata/src/component_manifest.rs

@@ -27,6 +27,7 @@ pub struct ManifestGroup {
     pub interface: String,
     pub modport: String,
     pub members: Vec<ManifestMember>,
+    pub doc: Option<String>,
 }
 
 /// One interface member a group binds; the connected interface must
@@ -363,6 +364,7 @@ impl ComponentManifest {
                                     .collect()
                             })
                             .unwrap_or_default(),
+                        doc: doc_of(g),
                     })
                     .collect()
             })