Merge pull request #1089 from Yarwin/fix-docs-not-generating-if-only-variables-are-present

Fix editor docs not generating when class itself is undocumented

Author: Bromeon

godot-core/src/docs.rs

@@ -86,9 +86,9 @@ pub fn gather_xml_docs() -> impl Iterator<Item = String> {
                 ..
             }) => map.entry(class_name).or_default().virtual_methods = virtual_method_docs,
 
-            PluginItem::Struct(Struct {
-                docs: Some(docs), ..
-            }) => map.entry(class_name).or_default().definition = docs,
+            PluginItem::Struct(Struct { docs, .. }) => {
+                map.entry(class_name).or_default().definition = docs
+            }
 
             _ => (),
         }

godot-core/src/registry/plugin.rs

@@ -189,12 +189,12 @@ pub struct Struct {
 
     /// Documentation extracted from the struct's RustDoc.
     #[cfg(all(since_api = "4.3", feature = "register-docs"))]
-    pub(crate) docs: Option<StructDocs>,
+    pub(crate) docs: StructDocs,
 }
 
 impl Struct {
     pub fn new<T: GodotClass + cap::ImplementsGodotExports>(
-        #[cfg(all(since_api = "4.3", feature = "register-docs"))] docs: Option<StructDocs>,
+        #[cfg(all(since_api = "4.3", feature = "register-docs"))] docs: StructDocs,
     ) -> Self {
         Self {
             base_class_name: T::Base::class_name(),

godot-macros/src/docs.rs

@@ -11,16 +11,16 @@ use crate::class::{ConstDefinition, Field, FuncDefinition, SignalDefinition};
 use proc_macro2::{Ident, TokenStream};
 use quote::{quote, ToTokens};
 
-/// Returns code containing the doc information of a `#[derive(GodotClass)] struct MyClass` declaration.
+/// Returns code containing the doc information of a `#[derive(GodotClass)] struct MyClass` declaration iff class or any of its members is documented.
 pub fn document_struct(
     base: String,
     description: &[venial::Attribute],
     fields: &[Field],
 ) -> TokenStream {
     let base_escaped = xml_escape(base);
-    let Some(desc_escaped) = attribute_docs_to_bbcode(description).map(xml_escape) else {
-        return quote! { None };
-    };
+    let desc_escaped = attribute_docs_to_bbcode(description)
+        .map(xml_escape)
+        .unwrap_or_default();
 
     let members = fields
         .iter()
@@ -29,13 +29,11 @@ pub fn document_struct(
         .collect::<String>();
 
     quote! {
-        Some(
             ::godot::docs::StructDocs {
                 base: #base_escaped,
                 description: #desc_escaped,
                 members: #members,
             }
-        )
     }
 }