v0.4.0 (with doc attributes)

Author: GodotRust

godot-bindings/src/header_gen.rs

@@ -57,7 +57,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

@@ -27,17 +27,17 @@ 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-2-1")]
+#[cfg(feature = "api-4-2-1")] #[cfg_attr(published_docs, doc(cfg(feature = "api-4-2-1")))]
 pub use gdextension_api::version_4_2_1 as prebuilt;
-#[cfg(feature = "api-4-2-2")]
+#[cfg(feature = "api-4-2-2")] #[cfg_attr(published_docs, doc(cfg(feature = "api-4-2-2")))]
 pub use gdextension_api::version_4_2_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;
 // ]]
 

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::*;
@@ -154,7 +155,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::*;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
@@ -218,7 +219,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(',')

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

@@ -241,7 +241,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-codegen/src/generator/central_files.rs

@@ -20,11 +20,11 @@ pub fn make_sys_central_code(api: &ExtensionApi) -> TokenStream {
     let [opaque_32bit, opaque_64bit] = make_opaque_types(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

@@ -125,7 +125,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! {

godot-codegen/src/generator/method_tables.rs

@@ -249,7 +249,7 @@ impl MethodInitGroup {
         }
     }
 
-    #[cfg(not(feature = "codegen-lazy-fptrs"))]
+    #[cfg(not(feature = "codegen-lazy-fptrs"))] #[cfg_attr(published_docs, doc(cfg(not(feature = "codegen-lazy-fptrs"))))]
     fn function_name(&self) -> Ident {
         format_ident!("load_{}_methods", self.class_name)
     }
@@ -303,7 +303,7 @@ fn make_named_method_table(info: NamedMethodTable) -> TokenStream {
     }
 }
 
-#[cfg(not(feature = "codegen-lazy-fptrs"))]
+#[cfg(not(feature = "codegen-lazy-fptrs"))] #[cfg_attr(published_docs, doc(cfg(not(feature = "codegen-lazy-fptrs"))))]
 fn make_method_table(info: IndexedMethodTable) -> TokenStream {
     let IndexedMethodTable {
         table_name,
@@ -415,7 +415,7 @@ fn make_method_table(info: IndexedMethodTable) -> TokenStream {
     }
 }
 
-#[cfg(feature = "codegen-lazy-fptrs")]
+#[cfg(feature = "codegen-lazy-fptrs")] #[cfg_attr(published_docs, doc(cfg(feature = "codegen-lazy-fptrs")))]
 fn make_method_table(info: IndexedMethodTable) -> TokenStream {
     let IndexedMethodTable {
         table_name,

godot-codegen/src/generator/virtual_definition_consts.rs

@@ -41,7 +41,7 @@ fn make_virtual_hashes_for_class(class: &Class, ctx: &mut Context) -> TokenStrea
 
     let constants = class.methods.iter().filter_map(|method| {
         let FnDirection::Virtual {
-            #[cfg(since_api = "4.4")]
+            #[cfg(since_api = "4.4")] #[cfg_attr(published_docs, doc(cfg(since_api = "4.4")))]
             hash,
         } = method.direction()
         else {
@@ -51,11 +51,11 @@ fn make_virtual_hashes_for_class(class: &Class, ctx: &mut Context) -> TokenStrea
         let rust_name = method.name_ident();
         let godot_name_str = method.godot_name();
 
-        #[cfg(since_api = "4.4")]
+        #[cfg(since_api = "4.4")] #[cfg_attr(published_docs, doc(cfg(since_api = "4.4")))]
         let constant = quote! {
             pub const #rust_name: (&'static str, u32) = (#godot_name_str, #hash);
         };
-        #[cfg(before_api = "4.4")]
+        #[cfg(before_api = "4.4")] #[cfg_attr(published_docs, doc(cfg(before_api = "4.4")))]
         let constant = quote! {
             pub const #rust_name: &'static str = #godot_name_str;
         };