Hide Derived SystemParam State Struct From Docs (#1984)

zicklag · zicklag · commit 6508b4ed2593 · 2021-04-22T23:09:59.000Z
This makes sure the automatically generated MyStructState type is not
shown in the rustdoc when deriving SystemParam on MyStruct.
diff --git a/crates/bevy_ecs/macros/src/lib.rs b/crates/bevy_ecs/macros/src/lib.rs
@@ -380,6 +380,7 @@ pub fn derive_system_param(input: TokenStream) -> TokenStream {
             type Fetch = #fetch_struct_name <(#(<#field_types as SystemParam>::Fetch,)*), #punctuated_generic_idents>;
         }
 
+        #[doc(hidden)]
         #fetch_struct_visibility struct #fetch_struct_name<TSystemParamState, #punctuated_generic_idents> {
             state: TSystemParamState,
             marker: std::marker::PhantomData<(#punctuated_generic_idents)>

Original file line number	Diff line number	Diff line change
`@@ -380,6 +380,7 @@ pub fn derive_system_param(input: TokenStream) -> TokenStream {`
`380`	`380`	`type Fetch = #fetch_struct_name <(#(<#field_types as SystemParam>::Fetch,)*), #punctuated_generic_idents>;`
`381`	`381`	`}`
`382`	`382`
	`383`	`+ #[doc(hidden)]`
`383`	`384`	`#fetch_struct_visibility struct #fetch_struct_name<TSystemParamState, #punctuated_generic_idents> {`
`384`	`385`	`state: TSystemParamState,`
`385`	`386`	`marker: std::marker::PhantomData<(#punctuated_generic_idents)>`