actix/actix-web
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-web synced 2025-06-26 23:17:42 +02:00
Code Issues Releases Wiki Activity

Port over doc comments in route macros. (#2022)

Browse Source 
Co-authored-by: Jonas Platte <jplatte@users.noreply.github.com>
Co-authored-by: Rob Ede <robjtede@icloud.com>
This commit is contained in:
Erik Johnston
2021-02-24 12:26:56 +00:00
committed by GitHub
parent f6393728c7
commit 42711c23d7
4 changed files with 40 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
actix-web-codegen/src/route.rs
View File

@ -176,6 +176,9 @@ pub struct Route {
args: Args,
ast: syn::ItemFn,
resource_type: ResourceType,
/// The doc comment attributes to copy to generated struct, if any.
doc_attributes: Vec<syn::Attribute>,
}
fn guess_resource_type(typ: &syn::Type) -> ResourceType {
@ -221,6 +224,18 @@ impl Route {
let ast: syn::ItemFn = syn::parse(input)?;
let name = ast.sig.ident.clone();
// Try and pull out the doc comments so that we can reapply them to the
// generated struct.
//
// Note that multi line doc comments are converted to multiple doc
// attributes.
let doc_attributes = ast
.attrs
.iter()
.filter(|attr| attr.path.is_ident("doc"))
.cloned()
.collect();
let args = Args::new(args, method)?;
if args.methods.is_empty() {
return Err(syn::Error::new(
@ -248,6 +263,7 @@ impl Route {
args,
ast,
resource_type,
doc_attributes,
})
}
}
@ -265,6 +281,7 @@ impl ToTokens for Route {
methods,
},
resource_type,
doc_attributes,
} = self;
let resource_name = name.to_string();
let method_guards = {
@ -287,6 +304,7 @@ impl ToTokens for Route {
};
let stream = quote! {
#(#doc_attributes)*
#[allow(non_camel_case_types, missing_docs)]
pub struct #name;