v0.5.1 (with doc attributes)

Author: GodotRust

godot-bindings/src/header_gen.rs

@@ -63,7 +63,7 @@ pub(crate) fn generate_rust_binding(in_h_path: &Path, out_rs_path: &Path) {
     });
 }
 
-//#[cfg(target_os = "macos")]
+//#[cfg(target_os = "macos")] #[cfg_attr(published_docs, doc(cfg(target_os = "macos")))]
 fn configure_platform_specific(builder: bindgen::Builder) -> bindgen::Builder {
     // On macOS arm64 architecture, we currently get the following error. Tried using different LLVM versions.
     // Not clear if bindgen can be configured in a better way.

godot-bindings/src/import.rs

@@ -26,15 +26,15 @@ pub const ALL_VERSIONS: &[(u8, u8, u8)] = &[
 
 // [version-sync] [[
 //  [line] #[cfg(feature = "api-$kebabVersion")]\npub use gdextension_api::version_$snakeVersion as prebuilt;
-#[cfg(feature = "api-4-2")]
+#[cfg(feature = "api-4-2")] #[cfg_attr(published_docs, doc(cfg(feature = "api-4-2")))]
 pub use gdextension_api::version_4_2 as prebuilt;
-#[cfg(feature = "api-4-3")]
+#[cfg(feature = "api-4-3")] #[cfg_attr(published_docs, doc(cfg(feature = "api-4-3")))]
 pub use gdextension_api::version_4_3 as prebuilt;
-#[cfg(feature = "api-4-4")]
+#[cfg(feature = "api-4-4")] #[cfg_attr(published_docs, doc(cfg(feature = "api-4-4")))]
 pub use gdextension_api::version_4_4 as prebuilt;
-#[cfg(feature = "api-4-5")]
+#[cfg(feature = "api-4-5")] #[cfg_attr(published_docs, doc(cfg(feature = "api-4-5")))]
 pub use gdextension_api::version_4_5 as prebuilt;
-#[cfg(feature = "api-4-6")]
+#[cfg(feature = "api-4-6")] #[cfg_attr(published_docs, doc(cfg(feature = "api-4-6")))]
 pub use gdextension_api::version_4_6 as prebuilt;
 // ]]
 

godot-bindings/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(published_docs, feature(doc_cfg))]
 /*
  * Copyright (c) godot-rust; Bromeon and contributors.
  * This Source Code Form is subject to the terms of the Mozilla Public
@@ -42,10 +43,10 @@ pub struct GodotVersion {
 // Custom mode: Regenerate all files
 
 // This file is explicitly included in unit tests. Needs regex dependency.
-#[cfg(test)]
+#[cfg(test)] #[cfg_attr(published_docs, doc(cfg(test)))]
 mod godot_version;
 
-#[cfg(feature = "api-custom")]
+#[cfg(feature = "api-custom")] #[cfg_attr(published_docs, doc(cfg(feature = "api-custom")))]
 #[path = ""]
 mod depend_on_custom {
     use std::borrow::Cow;
@@ -64,7 +65,7 @@ mod depend_on_custom {
         godot_exe::write_gdextension_headers(h_path, rs_path, false, watch);
     }
 
-    #[cfg(feature = "api-custom-extheader")]
+    #[cfg(feature = "api-custom-extheader")] #[cfg_attr(published_docs, doc(cfg(feature = "api-custom-extheader")))]
     pub fn write_gdextension_headers_from_c(h_path: &Path, rs_path: &Path, watch: &mut StopWatch) {
         godot_exe::write_gdextension_headers(h_path, rs_path, true, watch);
     }
@@ -74,13 +75,13 @@ mod depend_on_custom {
     }
 }
 
-#[cfg(feature = "api-custom")]
+#[cfg(feature = "api-custom")] #[cfg_attr(published_docs, doc(cfg(feature = "api-custom")))]
 pub use depend_on_custom::*;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Custom mode: Generate all files based on user provided JSON.
 
-#[cfg(feature = "api-custom-json")]
+#[cfg(feature = "api-custom-json")] #[cfg_attr(published_docs, doc(cfg(feature = "api-custom-json")))]
 #[path = ""]
 mod depend_on_custom_json {
     use std::borrow::Cow;
@@ -106,13 +107,13 @@ mod depend_on_custom_json {
     }
 }
 
-#[cfg(feature = "api-custom-json")]
+#[cfg(feature = "api-custom-json")] #[cfg_attr(published_docs, doc(cfg(feature = "api-custom-json")))]
 pub use depend_on_custom_json::*;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Prebuilt mode: Reuse existing files
 
-#[cfg(not(any(feature = "api-custom", feature = "api-custom-json")))]
+#[cfg(not(any(feature = "api-custom", feature = "api-custom-json")))] #[cfg_attr(published_docs, doc(cfg(not(any(feature = "api-custom", feature = "api-custom-json")))))]
 #[path = ""]
 mod depend_on_prebuilt {
     use super::*;
@@ -183,7 +184,7 @@ mod depend_on_prebuilt {
     }
 }
 
-#[cfg(not(any(feature = "api-custom", feature = "api-custom-json")))]
+#[cfg(not(any(feature = "api-custom", feature = "api-custom-json")))] #[cfg_attr(published_docs, doc(cfg(not(any(feature = "api-custom", feature = "api-custom-json")))))]
 pub use depend_on_prebuilt::*;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
@@ -247,7 +248,7 @@ pub fn emit_wasm_nothreads_cfg() {
 
     // The environment variable for target family has a list of applicable families separated by commas.
     // For Emscripten in particular, this can be "unix,wasm". Therefore, to check for the Wasm target, we must check each item in the list.
-    #[cfg(feature = "experimental-wasm-nothreads")]
+    #[cfg(feature = "experimental-wasm-nothreads")] #[cfg_attr(published_docs, doc(cfg(feature = "experimental-wasm-nothreads")))]
     if std::env::var("CARGO_CFG_TARGET_FAMILY")
         .expect("target family environment variable")
         .split(',')
@@ -302,11 +303,11 @@ pub fn emit_safeguard_levels() {
     let mut safeguards_level = if cfg!(debug_assertions) { 2 } else { 1 };
 
     // Override default level with Cargo feature, in dev/release profiles.
-    #[cfg(debug_assertions)]
+    #[cfg(debug_assertions)] #[cfg_attr(published_docs, doc(cfg(debug_assertions)))]
     if cfg!(feature = "safeguards-dev-balanced") {
         safeguards_level = 1;
     }
-    #[cfg(not(debug_assertions))]
+    #[cfg(not(debug_assertions))] #[cfg_attr(published_docs, doc(cfg(not(debug_assertions))))]
     if cfg!(feature = "safeguards-release-disengaged") {
         safeguards_level = 0;
     }
@@ -326,7 +327,7 @@ pub fn emit_safeguard_levels() {
 /// Try `new_name` env var first, fall back to `old_name` with a deprecation warning (only from `godot-codegen` build).
 /// The `once` static ensures the warning is emitted at most once per build.
 // TODO(v0.6): remove old names.
-#[cfg(any(feature = "api-custom", feature = "api-custom-json"))]
+#[cfg(any(feature = "api-custom", feature = "api-custom-json"))] #[cfg_attr(published_docs, doc(cfg(any(feature = "api-custom", feature = "api-custom-json"))))]
 pub(crate) fn env_var_or_deprecated(
     once: &'static std::sync::Once,
     new_name: &str,

godot-cell/src/borrow_state.rs

@@ -298,7 +298,7 @@ impl From<String> for BorrowStateErr {
     }
 }
 
-#[cfg(all(test, feature = "proptest"))]
+#[cfg(all(test, feature = "proptest"))] #[cfg_attr(published_docs, doc(cfg(all(test, feature = "proptest"))))]
 mod proptests {
     use proptest::arbitrary::Arbitrary;
     use proptest::collection::vec;
@@ -635,7 +635,7 @@ mod proptests {
     }
 }
 
-#[cfg(test)]
+#[cfg(test)] #[cfg_attr(published_docs, doc(cfg(test)))]
 mod test {
     use super::*;
 

godot-cell/src/cell.rs

@@ -276,7 +276,7 @@ impl<T> CellState<T> {
     }
 }
 
-#[cfg(test)]
+#[cfg(test)] #[cfg_attr(published_docs, doc(cfg(test)))]
 mod test {
     use super::*;
 

godot-cell/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(published_docs, feature(doc_cfg))]
 /*
  * Copyright (c) godot-rust; Bromeon and contributors.
  * This Source Code Form is subject to the terms of the Mozilla Public

godot-cell/tests/mock/blocking.rs

@@ -36,7 +36,7 @@ impl MyClass {
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 
-// NOTE: We have to ignore each test individually, instead of using #[cfg(test)] on a module containing them, so that
+// NOTE: We have to ignore each test individually, instead of using #[cfg(test)] #[cfg_attr(published_docs, doc(cfg(test)))] on a module containing them, so that
 // `cargo test` still lists those tests, while indicating the reason why they were ignored.
 
 /// Call each method from different threads, allowing them to run in parallel.

godot-codegen/src/conv/type_conversions.rs

@@ -272,7 +272,7 @@ fn to_rust_type_uncached(full_ty: &GodotTy, ctx: &mut Context) -> RustTy {
 
         return RustTy::TypedArray {
             tokens: quote! { Array<#tokens> },
-            #[cfg(not(feature = "codegen-full"))]
+            #[cfg(not(feature = "codegen-full"))] #[cfg_attr(published_docs, doc(cfg(not(feature = "codegen-full"))))]
             elem_class: (!ctx.is_builtin(elem_ty)).then(|| elem_ty.to_string()),
         };
     } else if let Some(kv_ty) = ty.strip_prefix("typeddictionary::") {
@@ -288,9 +288,9 @@ fn to_rust_type_uncached(full_ty: &GodotTy, ctx: &mut Context) -> RustTy {
 
         return RustTy::TypedDictionary {
             tokens: quote! { Dictionary<#key_tokens, #value_tokens> },
-            #[cfg(not(feature = "codegen-full"))]
+            #[cfg(not(feature = "codegen-full"))] #[cfg_attr(published_docs, doc(cfg(not(feature = "codegen-full"))))]
             key_class: (!ctx.is_builtin(key_ty)).then(|| key_ty.to_string()),
-            #[cfg(not(feature = "codegen-full"))]
+            #[cfg(not(feature = "codegen-full"))] #[cfg_attr(published_docs, doc(cfg(not(feature = "codegen-full"))))]
             value_class: (!ctx.is_builtin(value_ty)).then(|| value_ty.to_string()),
         };
     }
@@ -725,7 +725,7 @@ fn gdscript_to_rust_expr() {
         // Use arbitrary type if not specified -> should not be read
         let ty_dontcare = RustTy::TypedArray {
             tokens: TokenStream::new(),
-            #[cfg(not(feature = "codegen-full"))]
+            #[cfg(not(feature = "codegen-full"))] #[cfg_attr(published_docs, doc(cfg(not(feature = "codegen-full"))))]
             elem_class: None,
         };
         let ty = ty.unwrap_or(&ty_dontcare);

godot-codegen/src/generator/central_files.rs

@@ -21,11 +21,11 @@ pub fn make_sys_central_code(api: &ExtensionApi) -> TokenStream {
     let godot_type_name_method = make_godot_type_name_method(api);
 
     quote! {
-        #[cfg(target_pointer_width = "32")]
+        #[cfg(target_pointer_width = "32")] #[cfg_attr(published_docs, doc(cfg(target_pointer_width = "32")))]
         pub mod types {
             #(#opaque_32bit)*
         }
-        #[cfg(target_pointer_width = "64")]
+        #[cfg(target_pointer_width = "64")] #[cfg_attr(published_docs, doc(cfg(target_pointer_width = "64")))]
         pub mod types {
             #(#opaque_64bit)*
         }

godot-codegen/src/generator/classes.rs

@@ -124,7 +124,7 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
     let (cfg_attributes, cfg_inner_attributes);
     if class.is_experimental {
         cfg_attributes = quote! {
-            // #[cfg(feature = "experimental-godot-api")]
+            // #[cfg(feature = "experimental-godot-api")] #[cfg_attr(published_docs, doc(cfg(feature = "experimental-godot-api")))]
             #[cfg_attr(published_docs, doc(cfg(feature = "experimental-godot-api")))]
         };
         cfg_inner_attributes = quote! {