support multi see and other tag

Author: CppCXY

crates/emmylua_code_analysis/src/compilation/analyzer/doc/type_ref_tags.rs

@@ -389,15 +389,15 @@ pub fn analyze_other(analyzer: &mut DocAnalyzer, other: LuaDocTagOther) -> Optio
     let tag_name = other.get_tag_name()?;
     let description = if let Some(des) = other.get_description() {
         let description = preprocess_description(&des.get_description_text(), None);
-        format!("@*{}* {}", tag_name, description)
+        description
     } else {
-        format!("@*{}*", tag_name)
+        "".to_string()
     };
 
     analyzer
         .db
         .get_property_index_mut()
-        .add_other(analyzer.file_id, owner, description);
+        .add_other(analyzer.file_id, owner, tag_name, description);
 
     Some(())
 }

crates/emmylua_code_analysis/src/db_index/property/mod.rs

@@ -6,7 +6,7 @@ use emmylua_parser::{LuaVersionCondition, VisibilityKind};
 use property::LuaCommonProperty;
 pub use property::{LuaDeprecated, LuaExport, LuaExportScope, LuaPropertyId};
 
-use crate::FileId;
+use crate::{db_index::property::property::LuaTagContent, FileId};
 
 use super::{traits::LuaIndex, LuaSemanticDeclId};
 
@@ -161,7 +161,11 @@ impl LuaPropertyIndex {
         see_content: String,
     ) -> Option<()> {
         let property = self.get_or_create_property(owner_id.clone())?;
-        property.see_content = Some(Box::new(see_content));
+        let tag_content = property
+            .tag_content
+            .get_or_insert_with(|| Box::new(LuaTagContent::new()));
+
+        tag_content.add_tag("see".into(), see_content);
 
         self.in_filed_owner
             .entry(file_id)
@@ -175,17 +179,14 @@ impl LuaPropertyIndex {
         &mut self,
         file_id: FileId,
         owner_id: LuaSemanticDeclId,
+        tag_name: String,
         other_content: String,
     ) -> Option<()> {
         let property = self.get_or_create_property(owner_id.clone())?;
-        if let Some(content) = &property.other_content {
-            let mut content = content.clone();
-            content.push_str("\n\n");
-            content.push_str(&other_content);
-            property.other_content = Some(content);
-        } else {
-            property.other_content = Some(other_content.into());
-        }
+        let tag_content = property
+            .tag_content
+            .get_or_insert_with(|| Box::new(LuaTagContent::new()));
+        tag_content.add_tag(tag_name, other_content);
 
         self.in_filed_owner
             .entry(file_id)

crates/emmylua_code_analysis/src/db_index/property/property.rs

@@ -8,8 +8,7 @@ pub struct LuaCommonProperty {
     pub source: Option<Box<String>>,
     pub deprecated: Option<LuaDeprecated>,
     pub version_conds: Option<Box<Vec<LuaVersionCondition>>>,
-    pub see_content: Option<Box<String>>,
-    pub other_content: Option<Box<String>>,
+    pub tag_content: Option<Box<LuaTagContent>>,
     pub export: Option<LuaExport>,
 }
 
@@ -25,6 +24,25 @@ pub enum LuaExportScope {
     Namespace,
 }
 
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct LuaTagContent {
+    pub tags: Vec<(String, String)>,
+}
+
+impl LuaTagContent {
+    pub fn new() -> Self {
+        Self { tags: Vec::new() }
+    }
+
+    pub fn add_tag(&mut self, tag: String, content: String) {
+        self.tags.push((tag, content));
+    }
+
+    pub fn get_all_tags(&self) -> &[(String, String)] {
+        &self.tags
+    }
+}
+
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct LuaExport {
     pub scope: LuaExportScope,
@@ -39,8 +57,7 @@ impl LuaCommonProperty {
             source: None,
             deprecated: None,
             version_conds: None,
-            see_content: None,
-            other_content: None,
+            tag_content: None,
             export: None,
         }
     }

crates/emmylua_doc_cli/src/json_generator/export.rs

@@ -314,13 +314,21 @@ fn export_property(db: &DbIndex, semantic_decl: &LuaSemanticDeclId) -> Property
                 .as_ref()
                 .and_then(|s| s.to_str())
                 .map(|s| s.to_string()),
-            see: property.see_content.as_ref().map(|s| s.to_string()),
             deprecated: property.deprecated.is_some(),
             deprecation_reason: property.deprecated.as_ref().and_then(|s| match s {
                 LuaDeprecated::Deprecated => None,
                 LuaDeprecated::DeprecatedWithMessage(msg) => Some(msg.to_string()),
             }),
-            other: property.other_content.as_ref().map(|s| s.to_string()),
+            tag_content: property.tag_content.as_ref().map(|tag_content| {
+                tag_content
+                    .get_all_tags()
+                    .iter()
+                    .map(|(name, content)| TagNameContent {
+                        tag_name: name.clone(),
+                        content: content.clone(),
+                    })
+                    .collect()
+            }),
         },
         None => Default::default(),
     }

crates/emmylua_doc_cli/src/json_generator/json_types.rs

@@ -130,10 +130,15 @@ pub struct Field {
 pub struct Property {
     pub description: Option<String>,
     pub visibility: Option<String>,
-    pub see: Option<String>,
     pub deprecated: bool,
     pub deprecation_reason: Option<String>,
-    pub other: Option<String>,
+    pub tag_content: Option<Vec<TagNameContent>>,
+}
+
+#[derive(Debug, Serialize, Deserialize, Default)]
+pub struct TagNameContent {
+    pub tag_name: String,
+    pub content: String,
 }
 
 #[derive(Debug, Serialize, Deserialize, Default)]

crates/emmylua_doc_cli/src/markdown_generator/gen/mod.rs

@@ -19,10 +19,6 @@ fn collect_property(db: &DbIndex, semantic_decl: LuaSemanticDeclId) -> Property
             doc_property.description = Some(description.to_string());
         }
 
-        if let Some(see) = property.see_content.clone() {
-            doc_property.see = Some(see.to_string());
-        }
-
         if let Some(deprecated) = &property.deprecated {
             match deprecated {
                 LuaDeprecated::Deprecated => {
@@ -33,8 +29,26 @@ fn collect_property(db: &DbIndex, semantic_decl: LuaSemanticDeclId) -> Property
                 }
             }
         }
-        if let Some(other) = property.other_content.clone() {
-            doc_property.other = Some(other.to_string());
+
+        if let Some(tag_content) = &property.tag_content {
+            for (tag_name, content) in tag_content.get_all_tags() {
+                match tag_name.as_str() {
+                    "see" => {
+                        let see_content = doc_property.see.get_or_insert_with(String::new);
+                        if !see_content.is_empty() {
+                            see_content.push_str("\n");
+                        }
+                        see_content.push_str(content);
+                    }
+                    _ => {
+                        let other_content = doc_property.other.get_or_insert_with(String::new);
+                        if !other_content.is_empty() {
+                            other_content.push_str("\n");
+                        }
+                        other_content.push_str(&format!("@{} {}", tag_name, content));
+                    }
+                }
+            }
         }
     }
 

crates/emmylua_ls/src/handlers/hover/hover_builder.rs

@@ -24,9 +24,7 @@ pub struct HoverBuilder<'a> {
     /// Type expansion, often used for alias types
     pub type_expansion: Option<Vec<String>>,
     /// see
-    see_content: Option<String>,
-    /// other
-    other_content: Option<String>,
+    tag_content: Option<Vec<(String, String)>>,
 
     pub is_completion: bool,
     trigger_token: Option<LuaSyntaxToken>,
@@ -51,8 +49,7 @@ impl<'a> HoverBuilder<'a> {
             is_completion,
             trigger_token: token,
             type_expansion: None,
-            see_content: None,
-            other_content: None,
+            tag_content: None,
         }
     }
 
@@ -146,11 +143,8 @@ impl<'a> HoverBuilder<'a> {
                 self.add_annotation_description(description);
             }
 
-            if let Some(see) = desc_info.see_content {
-                self.see_content = Some(see);
-            }
-            if let Some(other) = desc_info.other_content {
-                self.other_content = Some(other);
+            if let Some(tag_content) = desc_info.tag_content {
+                self.tag_content = Some(tag_content);
             }
 
             Some(())
@@ -244,14 +238,12 @@ impl<'a> HoverBuilder<'a> {
                 }
             }
 
-            if let Some(see_content) = &self.see_content {
-                content.push_str(&format!("\n@*see* {}\n", see_content));
+            if let Some(tag_content) = &self.tag_content {
+                for (tag_name, description) in tag_content {
+                    content.push_str(&format!("\n@*{}* {}\n", tag_name, description));
+                }
             }
 
-            if let Some(other) = &self.other_content {
-                content.push_str("\n\n");
-                content.push_str(other);
-            }
             content
         };
 

crates/emmylua_ls/src/handlers/hover/hover_humanize.rs

@@ -142,21 +142,19 @@ pub fn infer_prefix_global_name<'a>(
 #[derive(Debug, Clone)]
 pub struct DescriptionInfo {
     pub description: Option<String>,
-    pub see_content: Option<String>,
-    pub other_content: Option<String>,
+    pub tag_content: Option<Vec<(String, String)>>,
 }
 
 impl DescriptionInfo {
     pub fn new() -> Self {
         Self {
             description: None,
-            see_content: None,
-            other_content: None,
+            tag_content: None,
         }
     }
 
     pub fn is_empty(&self) -> bool {
-        self.description.is_none() && self.see_content.is_none() && self.other_content.is_none()
+        self.description.is_none() && self.tag_content.is_none()
     }
 }
 
@@ -209,11 +207,15 @@ pub fn extract_description_from_property_owner(
         result.description = Some(description);
     }
 
-    if let Some(see) = &property.see_content {
-        result.see_content = Some(see.to_string());
-    }
-    if let Some(other) = &property.other_content {
-        result.other_content = Some(other.to_string());
+    if let Some(tag_content) = &property.tag_content {
+        for (tag_name, description) in tag_content.get_all_tags() {
+            if result.tag_content.is_none() {
+                result.tag_content = Some(Vec::new());
+            }
+            if let Some(tag_content) = &mut result.tag_content {
+                tag_content.push((tag_name.clone(), description.clone()));
+            }
+        }
     }
 
     if result.is_empty() {