dan/oxc
1
0
Fork 0
mirror of https://github.com/danbulant/oxc synced 2026-05-25 04:42:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(ast): improve formatting of AstBuilder doc comments (#6756)

Browse source
This commit is contained in:
overlookmotel 2024-10-22 00:12:01 +00:00
parent b8845773f7
commit 46720be7af
2 changed files with 370 additions and 370 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

736
crates/oxc_ast/src/generated/ast_builder.rs
View file

File diff suppressed because it is too large Load diff

4
tasks/ast_tools/src/generators/ast_builder.rs
View file

@ -285,12 +285,12 @@ fn generate_struct_builder_fn(ty: &StructDef, ctx: &LateCtx) -> TokenStream {
let alloc_fn_name = format_ident!("alloc_{fn_name}"); let alloc_fn_name = format_ident!("alloc_{fn_name}");
let article = article_for(ident.to_string()); let article = article_for(ident.to_string());
let fn_docs = DocComment::new(format!("Build {article} [`{ident}`]")) let fn_docs = DocComment::new(format!("Build {article} [`{ident}`]."))
.with_description(format!("If you want the built node to be allocated in the memory arena, use [`AstBuilder::{alloc_fn_name}`] instead.")) .with_description(format!("If you want the built node to be allocated in the memory arena, use [`AstBuilder::{alloc_fn_name}`] instead."))
.with_params(&params); .with_params(&params);
let alloc_docs = let alloc_docs =
DocComment::new(format!("Build {article} [`{ident}`] and stores it in the memory arena.")) DocComment::new(format!("Build {article} [`{ident}`], and store it in the memory arena."))
.with_description(format!("Returns a [`Box`] containing the newly-allocated node. If you want a stack-allocated node, use [`AstBuilder::{fn_name}`] instead.")) .with_description(format!("Returns a [`Box`] containing the newly-allocated node. If you want a stack-allocated node, use [`AstBuilder::{fn_name}`] instead."))
.with_params(&params); .with_params(&params);