nordic-dev.net/bytemuck
2
0
Fork 0
mirror of https://github.com/Lokathor/bytemuck.git synced 2024-11-25 08:12:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation to generated public items (#236)

Browse Source 
Fixes #235
This commit is contained in:
Julien Cretin 2024-04-17 17:56:34 +02:00 committed by GitHub
parent eeb6e9dd53
commit 7ef8801cff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
derive/src/traits.rs
View File

@ -485,6 +485,7 @@ fn generate_checked_bit_pattern_struct(
Ok(( Ok((
quote! { quote! {
#[doc = #GENERATED_TYPE_DOCUMENTATION]
#repr #repr
#[derive(Clone, Copy, #crate_name::AnyBitPattern)] #[derive(Clone, Copy, #crate_name::AnyBitPattern)]
#derive_dbg #derive_dbg
@ -652,6 +653,7 @@ fn generate_checked_bit_pattern_enum_with_fields(
Ok(( Ok((
quote! { quote! {
#[doc = #GENERATED_TYPE_DOCUMENTATION]
#[derive(::core::clone::Clone, ::core::marker::Copy, #crate_name::AnyBitPattern)] #[derive(::core::clone::Clone, ::core::marker::Copy, #crate_name::AnyBitPattern)]
#derive_dbg #derive_dbg
#bits_repr #bits_repr
@ -703,6 +705,7 @@ fn generate_checked_bit_pattern_enum_with_fields(
Ok(( Ok((
quote! { quote! {
#[doc = #GENERATED_TYPE_DOCUMENTATION]
#[derive(::core::clone::Clone, ::core::marker::Copy, #crate_name::CheckedBitPattern)] #[derive(::core::clone::Clone, ::core::marker::Copy, #crate_name::CheckedBitPattern)]
#[repr(C)] #[repr(C)]
#vis struct #bits_ty(#(#fields),*); #vis struct #bits_ty(#(#fields),*);
@ -775,6 +778,7 @@ fn generate_checked_bit_pattern_enum_with_fields(
Ok(( Ok((
quote! { quote! {
#[doc = #GENERATED_TYPE_DOCUMENTATION]
#[derive(::core::clone::Clone, ::core::marker::Copy, #crate_name::AnyBitPattern)] #[derive(::core::clone::Clone, ::core::marker::Copy, #crate_name::AnyBitPattern)]
#bits_repr #bits_repr
#[allow(non_snake_case)] #[allow(non_snake_case)]
@ -1263,3 +1267,6 @@ pub fn bytemuck_crate_name(input: &DeriveInput) -> TokenStream {
return crate_name; return crate_name;
} }
const GENERATED_TYPE_DOCUMENTATION: &str =
" `bytemuck`-generated type for internal purposes only.";