Mirrors/dioxus
2
0
Fork 0
mirror of https://github.com/DioxusLabs/dioxus synced 2025-02-17 06:08:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1573 from tigerros/fix-props-docs-line-breaks

Browse source 
Fix prop docs line breaks
This commit is contained in:
Jonathan Kelley 2023-10-25 17:03:46 -04:00 • committed by GitHub
commit 035f26d4bf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
packages/core-macro/src/component_body_deserializers/inline_props.rs
View file

@ -186,13 +186,13 @@ fn get_props_docs(fn_ident: &Ident, inputs: Vec<&FnArg>) -> Vec<Attribute> {
let arg_name = arg_name.into_token_stream().to_string(); let arg_name = arg_name.into_token_stream().to_string();
let arg_type = crate::utils::format_type_string(arg_type); let arg_type = crate::utils::format_type_string(arg_type);
let input_arg_doc = let input_arg_doc = keep_up_to_n_consecutive_chars(input_arg_doc.trim(), 2, '\n')
keep_up_to_n_consecutive_chars(input_arg_doc.trim(), 2, '\n').replace('\n', "<br/>"); .replace("\n\n", "</p><p>");
let prop_def_link = format!("{props_def_link}::{arg_name}"); let prop_def_link = format!("{props_def_link}::{arg_name}");
let mut arg_doc = format!("- [`{arg_name}`]({prop_def_link}) : `{arg_type}`"); let mut arg_doc = format!("- [`{arg_name}`]({prop_def_link}) : `{arg_type}`");
if let Some(deprecation) = deprecation { if let Some(deprecation) = deprecation {
arg_doc.push_str("<br/>👎 Deprecated"); arg_doc.push_str("<p>👎 Deprecated");
if let Some(since) = deprecation.since { if let Some(since) = deprecation.since {
arg_doc.push_str(&format!(" since {since}")); arg_doc.push_str(&format!(" since {since}"));
@ -205,14 +205,16 @@ fn get_props_docs(fn_ident: &Ident, inputs: Vec<&FnArg>) -> Vec<Attribute> {
arg_doc.push_str(&format!(": {note}")); arg_doc.push_str(&format!(": {note}"));
} }
arg_doc.push_str("</p>");
if !input_arg_doc.is_empty() { if !input_arg_doc.is_empty() {
arg_doc.push_str("<hr/>"); arg_doc.push_str("<hr/>");
} }
} else {
arg_doc.push_str("<br/>");
} }
arg_doc.push_str(&input_arg_doc); if !input_arg_doc.is_empty() {
arg_doc.push_str(&format!("<p>{input_arg_doc}</p>"));
}
props_docs.push(parse_quote! { props_docs.push(parse_quote! {
#[doc = #arg_doc] #[doc = #arg_doc]