From 5dc8b20c8da6c6904ecbdb23827827f039b1f0fd Mon Sep 17 00:00:00 2001 From: Stephen Chung Date: Sun, 5 Jun 2022 18:07:20 +0800 Subject: [PATCH] Add #[doc(hidden)] to plugin-generated artifacts. --- CHANGELOG.md | 1 + codegen/src/function.rs | 6 ++ codegen/src/rhai_module.rs | 3 + codegen/src/test/function.rs | 22 ++++++ codegen/src/test/module.rs | 142 +++++++++++++++++++++++++++++++++++ 5 files changed, 174 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cfdd0cf9..b953235b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ Bug fixes * Missing `to_int` from `Decimal` is added. * Parsing of index expressions is relaxed and many cases no longer result in an index-type error to allow for custom indexers. * Merging or combining a self-contained `AST` into another `AST` now works properly. +* Plugin modules/functions no longer generate errors under `#![deny(missing_docs)]`. Deprecated API's ---------------- diff --git a/codegen/src/function.rs b/codegen/src/function.rs index e276cfa8..149f6bfb 100644 --- a/codegen/src/function.rs +++ b/codegen/src/function.rs @@ -620,6 +620,7 @@ impl ExportedFn { #[automatically_derived] #vis mod #name { use super::*; + #[doc(hidden)] pub struct Token(); #impl_block #dyn_result_fn_block @@ -655,6 +656,9 @@ impl ExportedFn { .resolved_at(Span::call_site()); if self.params.return_raw.is_some() { quote_spanned! { return_span => + #[allow(unused)] + #[doc(hidden)] + #[inline(always)] pub #dynamic_signature { #name(#(#arguments),*).map(Dynamic::from) } @@ -662,6 +666,7 @@ impl ExportedFn { } else { quote_spanned! { return_span => #[allow(unused)] + #[doc(hidden)] #[inline(always)] pub #dynamic_signature { Ok(Dynamic::from(#name(#(#arguments),*))) @@ -864,6 +869,7 @@ impl ExportedFn { quote! { #(#cfg_attrs)* + #[doc(hidden)] impl #type_name { #param_names #[inline(always)] pub fn param_types() -> [TypeId; #arg_count] { [#(#input_type_exprs),*] } diff --git a/codegen/src/rhai_module.rs b/codegen/src/rhai_module.rs index ccd40601..0e03917f 100644 --- a/codegen/src/rhai_module.rs +++ b/codegen/src/rhai_module.rs @@ -239,6 +239,7 @@ pub fn generate_body( gen_fn_tokens.push(quote! { #(#cfg_attrs)* #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct #fn_token_name(); }); @@ -250,6 +251,7 @@ pub fn generate_body( #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -257,6 +259,7 @@ pub fn generate_body( m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { #(#set_fn_statements)* #(#set_const_statements)* diff --git a/codegen/src/test/function.rs b/codegen/src/test/function.rs index 04d693b2..f187c5ed 100644 --- a/codegen/src/test/function.rs +++ b/codegen/src/test/function.rs @@ -275,7 +275,9 @@ mod generate_tests { #[automatically_derived] pub mod rhai_fn_do_nothing { use super::*; + #[doc(hidden)] pub struct Token(); + #[doc(hidden)] impl Token { pub const PARAM_NAMES: &'static [&'static str] = &["()"]; #[inline(always)] pub fn param_types() -> [TypeId; 0usize] { [] } @@ -288,6 +290,7 @@ mod generate_tests { #[inline(always)] fn is_method_call(&self) -> bool { false } } #[allow(unused)] + #[doc(hidden)] #[inline(always)] pub fn dynamic_result_fn() -> RhaiResult { Ok(Dynamic::from(do_nothing())) } @@ -308,7 +311,9 @@ mod generate_tests { #[automatically_derived] pub mod rhai_fn_do_something { use super::*; + #[doc(hidden)] pub struct Token(); + #[doc(hidden)] impl Token { pub const PARAM_NAMES: &'static [&'static str] = &["x: usize", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -323,6 +328,7 @@ mod generate_tests { #[inline(always)] fn is_method_call(&self) -> bool { false } } #[allow(unused)] + #[doc(hidden)] #[inline(always)] pub fn dynamic_result_fn(x: usize) -> RhaiResult { Ok(Dynamic::from(do_something(x))) } @@ -343,7 +349,9 @@ mod generate_tests { #[automatically_derived] pub mod rhai_fn_do_something { use super::*; + #[doc(hidden)] pub struct Token(); + #[doc(hidden)] impl Token { pub const PARAM_NAMES: &'static [&'static str] = &["x: usize", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -358,6 +366,7 @@ mod generate_tests { #[inline(always)] fn is_method_call(&self) -> bool { false } } #[allow(unused)] + #[doc(hidden)] #[inline(always)] pub fn dynamic_result_fn(context: NativeCallContext, x: usize) -> RhaiResult { Ok(Dynamic::from(do_something(context, x))) } @@ -381,7 +390,9 @@ mod generate_tests { #[automatically_derived] pub mod rhai_fn_return_dynamic { use super::*; + #[doc(hidden)] pub struct Token(); + #[doc(hidden)] impl Token { pub const PARAM_NAMES: &'static [&'static str] = &["rhai::Dynamic"]; #[inline(always)] pub fn param_types() -> [TypeId; 0usize] { [] } @@ -395,6 +406,7 @@ mod generate_tests { #[inline(always)] fn is_method_call(&self) -> bool { false } } #[allow(unused)] + #[doc(hidden)] #[inline(always)] pub fn dynamic_result_fn() -> RhaiResult { Ok(Dynamic::from(return_dynamic())) } @@ -412,6 +424,7 @@ mod generate_tests { }; let expected_tokens = quote! { + #[doc(hidden)] impl TestStruct { pub const PARAM_NAMES: &'static [&'static str] = &["x: usize", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -441,7 +454,9 @@ mod generate_tests { #[automatically_derived] pub mod rhai_fn_add_together { use super::*; + #[doc(hidden)] pub struct Token(); + #[doc(hidden)] impl Token { pub const PARAM_NAMES: &'static [&'static str] = &["x: usize", "y: usize", "usize"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -457,6 +472,7 @@ mod generate_tests { #[inline(always)] fn is_method_call(&self) -> bool { false } } #[allow(unused)] + #[doc(hidden)] #[inline(always)] pub fn dynamic_result_fn(x: usize, y: usize) -> RhaiResult { Ok(Dynamic::from(add_together(x, y))) } @@ -477,7 +493,9 @@ mod generate_tests { #[automatically_derived] pub mod rhai_fn_increment { use super::*; + #[doc(hidden)] pub struct Token(); + #[doc(hidden)] impl Token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut usize", "y: usize", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -496,6 +514,7 @@ mod generate_tests { #[inline(always)] fn is_method_call(&self) -> bool { true } } #[allow(unused)] + #[doc(hidden)] #[inline(always)] pub fn dynamic_result_fn(x: &mut usize, y: usize) -> RhaiResult { Ok(Dynamic::from(increment(x, y))) } @@ -517,7 +536,9 @@ mod generate_tests { #[automatically_derived] pub mod rhai_fn_special_print { use super::*; + #[doc(hidden)] pub struct Token(); + #[doc(hidden)] impl Token { pub const PARAM_NAMES: &'static [&'static str] = &["message: &str", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -532,6 +553,7 @@ mod generate_tests { #[inline(always)] fn is_method_call(&self) -> bool { false } } #[allow(unused)] + #[doc(hidden)] #[inline(always)] pub fn dynamic_result_fn(message: &str) -> RhaiResult { Ok(Dynamic::from(special_print(message))) } diff --git a/codegen/src/test/module.rs b/codegen/src/test/module.rs index be9b93e5..881746b9 100644 --- a/codegen/src/test/module.rs +++ b/codegen/src/test/module.rs @@ -323,6 +323,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -330,6 +331,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { if flatten {} else {} } @@ -358,6 +360,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -365,6 +368,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("get_mystic_number", FnNamespace::Internal, FnAccess::Public, Some(get_mystic_number_token::PARAM_NAMES), &[], @@ -372,7 +376,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct get_mystic_number_token(); + #[doc(hidden)] impl get_mystic_number_token { pub const PARAM_NAMES: &'static [&'static str] = &["INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 0usize] { [] } @@ -426,6 +432,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -433,6 +440,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn_with_comments("get_mystic_number", FnNamespace::Internal, FnAccess::Public, Some(get_mystic_number_token::PARAM_NAMES), &[], &[ @@ -445,7 +453,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct get_mystic_number_token(); + #[doc(hidden)] impl get_mystic_number_token { pub const PARAM_NAMES: &'static [&'static str] = &["INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 0usize] { [] } @@ -484,6 +494,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -491,6 +502,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("add_one_to", FnNamespace::Global, FnAccess::Public, Some(add_one_to_token::PARAM_NAMES), &[TypeId::of::()], @@ -498,7 +510,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct add_one_to_token(); + #[doc(hidden)] impl add_one_to_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: INT", "INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -537,6 +551,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -544,6 +559,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("add_one_to", FnNamespace::Internal, FnAccess::Public, Some(add_one_to_token::PARAM_NAMES), &[TypeId::of::()], @@ -551,7 +567,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct add_one_to_token(); + #[doc(hidden)] impl add_one_to_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: INT", "INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -601,6 +619,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -608,6 +627,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("add_n", FnNamespace::Internal, FnAccess::Public, Some(add_one_to_token::PARAM_NAMES), &[TypeId::of::()], @@ -618,7 +638,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct add_one_to_token(); + #[doc(hidden)] impl add_one_to_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: INT", "INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -634,7 +656,9 @@ mod generate_tests { } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct add_n_to_token(); + #[doc(hidden)] impl add_n_to_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: INT", "y: INT", "INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -674,6 +698,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -681,6 +706,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("add_together", FnNamespace::Internal, FnAccess::Public, Some(add_together_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::()], @@ -688,7 +714,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct add_together_token(); + #[doc(hidden)] impl add_together_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: INT", "y: INT", "INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -729,6 +757,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -736,6 +765,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("add", FnNamespace::Internal, FnAccess::Public, Some(add_together_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::()], @@ -749,7 +779,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct add_together_token(); + #[doc(hidden)] impl add_together_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: INT", "y: INT", "INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -803,6 +835,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -810,6 +843,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("get_mystic_number", FnNamespace::Internal, FnAccess::Public, Some(get_mystic_number_token::PARAM_NAMES), &[TypeId::of::()], @@ -820,7 +854,9 @@ mod generate_tests { } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct get_mystic_number_token(); + #[doc(hidden)] impl get_mystic_number_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut Hello", "INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -858,6 +894,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -865,6 +902,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("MYSTIC_NUMBER", MYSTIC_NUMBER); if flatten {} else {} @@ -892,6 +930,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -899,6 +938,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("MYSTIC_NUMBER", MYSTIC_NUMBER); if flatten {} else {} @@ -928,6 +968,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -935,6 +976,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { if flatten {} else {} } @@ -964,6 +1006,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -971,6 +1014,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { if flatten {} else {} } @@ -1006,6 +1050,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1013,6 +1058,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("get_mystic_number", FnNamespace::Internal, FnAccess::Public, Some(get_mystic_number_token::PARAM_NAMES), &[], @@ -1020,7 +1066,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct get_mystic_number_token(); + #[doc(hidden)] impl get_mystic_number_token { pub const PARAM_NAMES: &'static [&'static str] = &["INT"]; #[inline(always)] pub fn param_types() -> [TypeId; 0usize] { [] } @@ -1054,6 +1102,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1061,6 +1110,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { if flatten {} else {} } @@ -1089,6 +1139,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1096,6 +1147,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("print_out_to", FnNamespace::Internal, FnAccess::Public, Some(print_out_to_token::PARAM_NAMES), &[TypeId::of::()], @@ -1103,7 +1155,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct print_out_to_token(); + #[doc(hidden)] impl print_out_to_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &str", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -1142,6 +1196,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1149,6 +1204,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("print_out_to", FnNamespace::Internal, FnAccess::Public, Some(print_out_to_token::PARAM_NAMES), &[TypeId::of::()], @@ -1156,7 +1212,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct print_out_to_token(); + #[doc(hidden)] impl print_out_to_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: String", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -1196,6 +1254,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1203,6 +1262,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("foo", FnNamespace::Internal, FnAccess::Public, Some(foo_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::()], @@ -1210,7 +1270,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct foo_token(); + #[doc(hidden)] impl foo_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut FLOAT", "y: INT", "FLOAT"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -1250,6 +1312,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1257,6 +1320,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("increment", FnNamespace::Internal, FnAccess::Public, Some(increment_token::PARAM_NAMES), &[TypeId::of::()], @@ -1264,7 +1328,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct increment_token(); + #[doc(hidden)] impl increment_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut FLOAT", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -1309,6 +1375,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1316,6 +1383,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("increment", FnNamespace::Internal, FnAccess::Public, Some(increment_token::PARAM_NAMES), &[TypeId::of::()], @@ -1323,7 +1391,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct increment_token(); + #[doc(hidden)] impl increment_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut FLOAT", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -1344,6 +1414,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1351,6 +1422,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { if flatten { { self::it_is::rhai_generate_into_module(m, flatten); } @@ -1389,6 +1461,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1396,6 +1469,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("increment", FnNamespace::Internal, FnAccess::Public, Some(increment_token::PARAM_NAMES), &[TypeId::of::()], @@ -1403,7 +1477,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct increment_token(); + #[doc(hidden)] impl increment_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut FLOAT", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -1424,6 +1500,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1431,6 +1508,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { if flatten { { @@ -1470,6 +1548,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1477,6 +1556,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("get$square", FnNamespace::Global, FnAccess::Public, Some(int_foo_token::PARAM_NAMES), &[TypeId::of::()], @@ -1484,7 +1564,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct int_foo_token(); + #[doc(hidden)] impl int_foo_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut u64", "u64"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -1527,6 +1609,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1534,6 +1617,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("square", FnNamespace::Internal, FnAccess::Public, Some(int_foo_token::PARAM_NAMES), &[TypeId::of::()], @@ -1544,7 +1628,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct int_foo_token(); + #[doc(hidden)] impl int_foo_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut u64", "u64"]; #[inline(always)] pub fn param_types() -> [TypeId; 1usize] { [TypeId::of::()] } @@ -1587,6 +1673,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1594,6 +1681,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("set$squared", FnNamespace::Global, FnAccess::Public, Some(int_foo_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::()], @@ -1601,7 +1689,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct int_foo_token(); + #[doc(hidden)] impl int_foo_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut u64", "y: u64", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -1645,6 +1735,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1652,6 +1743,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("set_sq", FnNamespace::Internal, FnAccess::Public, Some(int_foo_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::()], @@ -1662,7 +1754,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct int_foo_token(); + #[doc(hidden)] impl int_foo_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut u64", "y: u64", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -1706,6 +1800,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1713,6 +1808,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("index$get$", FnNamespace::Global, FnAccess::Public, Some(get_by_index_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::()], @@ -1720,7 +1816,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct get_by_index_token(); + #[doc(hidden)] impl get_by_index_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut MyCollection", "i: u64", "FLOAT"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -1768,6 +1866,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1775,6 +1874,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { #[cfg(hello)] m.set_fn("index$get$", FnNamespace::Global, FnAccess::Public, Some(get_by_index_token::PARAM_NAMES), @@ -1784,8 +1884,10 @@ mod generate_tests { } #[cfg(hello)] #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct get_by_index_token(); #[cfg(hello)] + #[doc(hidden)] impl get_by_index_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut MyCollection", "i: u64", "FLOAT"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -1830,6 +1932,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1837,6 +1940,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("get", FnNamespace::Internal, FnAccess::Public, Some(get_by_index_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::()], @@ -1847,7 +1951,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct get_by_index_token(); + #[doc(hidden)] impl get_by_index_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut MyCollection", "i: u64", "FLOAT"]; #[inline(always)] pub fn param_types() -> [TypeId; 2usize] { [TypeId::of::(), TypeId::of::()] } @@ -1891,6 +1997,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1898,6 +2005,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("index$set$", FnNamespace::Global, FnAccess::Public, Some(set_by_index_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::(), TypeId::of::()], @@ -1905,7 +2013,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct set_by_index_token(); + #[doc(hidden)] impl set_by_index_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut MyCollection", "i: u64", "item: FLOAT", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 3usize] { [TypeId::of::(), TypeId::of::(), TypeId::of::()] } @@ -1950,6 +2060,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -1957,6 +2068,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_fn("set", FnNamespace::Internal, FnAccess::Public, Some(set_by_index_token::PARAM_NAMES), &[TypeId::of::(), TypeId::of::(), TypeId::of::()], @@ -1967,7 +2079,9 @@ mod generate_tests { if flatten {} else {} } #[allow(non_camel_case_types)] + #[doc(hidden)] pub struct set_by_index_token(); + #[doc(hidden)] impl set_by_index_token { pub const PARAM_NAMES: &'static [&'static str] = &["x: &mut MyCollection", "i: u64", "item: FLOAT", "()"]; #[inline(always)] pub fn param_types() -> [TypeId; 3usize] { [TypeId::of::(), TypeId::of::(), TypeId::of::()] } @@ -2010,6 +2124,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2017,6 +2132,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("MYSTIC_NUMBER", MYSTIC_NUMBER); if flatten {} else {} @@ -2025,6 +2141,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2032,6 +2149,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { if flatten { { self::it_is::rhai_generate_into_module(m, flatten); } @@ -2067,6 +2185,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2074,6 +2193,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("MYSTIC_NUMBER", MYSTIC_NUMBER); if flatten {} else {} @@ -2085,6 +2205,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2092,6 +2213,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { #[cfg(hello)] m.set_var("SPECIAL_CPU_NUMBER", SPECIAL_CPU_NUMBER); @@ -2101,6 +2223,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2108,6 +2231,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { if flatten { { self::first_is::rhai_generate_into_module(m, flatten); } @@ -2168,6 +2292,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2175,6 +2300,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE); if flatten {} else {} @@ -2185,6 +2311,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2192,6 +2319,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE); if flatten {} else {} @@ -2200,6 +2328,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2207,6 +2336,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE); @@ -2224,6 +2354,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2231,6 +2362,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE); if flatten {} else {} @@ -2239,6 +2371,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2246,6 +2379,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE); @@ -2265,6 +2399,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2272,6 +2407,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE); if flatten {} else {} @@ -2282,6 +2418,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2289,6 +2426,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE); if flatten {} else {} @@ -2297,6 +2435,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2304,6 +2443,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE); @@ -2319,6 +2459,7 @@ mod generate_tests { #[allow(unused_imports)] use super::*; + #[doc(hidden)] pub fn rhai_module_generate() -> Module { let mut m = Module::new(); rhai_generate_into_module(&mut m, false); @@ -2326,6 +2467,7 @@ mod generate_tests { m } #[allow(unused_mut)] + #[doc(hidden)] pub fn rhai_generate_into_module(m: &mut Module, flatten: bool) { m.set_var("VALUE", VALUE);