noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Merge pull request #120453 from dalexeev/gds-fix-base-doc-class-name

Browse Source 
GDScript: Fix incorrect detection of base doc class name
This commit is contained in:
Thaddeus Crews
2026-06-24 10:16:09 -05:00
parent 0c3a133051 998ed7355a
commit e78c7da64e
2 changed files with 23 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/gdscript/editor/gdscript_docgen.cpp
+20 -17
View File
@@ -62,6 +62,20 @@ String GDScriptDocGen::_get_class_name(const GDP::ClassNode &p_class) {
return full_name;
}
String GDScriptDocGen::_get_gdscript_name(const GDScript *p_script) {
if (p_script->local_name.is_empty()) {
// This is an outer unnamed class.
return _get_script_name(p_script->get_script_path());
} else {
// This is an inner or global outer class.
String name = p_script->local_name;
if (p_script->_owner) {
name = _get_gdscript_name(p_script->_owner) + "." + name;
}
return name;
}
}
void GDScriptDocGen::_doctype_from_gdtype(const GDType &p_gdtype, String &r_type, String &r_enum, bool p_is_return) {
if (!p_gdtype.is_hard_type()) {
r_type = "Variant";
@@ -336,27 +350,16 @@ void GDScriptDocGen::_generate_docs(GDScript *p_script, const GDP::ClassNode *p_
doc.is_script_doc = true;
if (p_script->local_name == StringName()) {
// This is an outer unnamed class.
doc.name = _get_script_name(p_script->get_script_path());
} else {
// This is an inner or global outer class.
doc.name = p_script->local_name;
if (p_script->_owner) {
doc.name = p_script->_owner->doc.name + "." + doc.name;
}
}
doc.name = _get_gdscript_name(p_script);
doc.script_path = p_script->get_script_path();
if (p_script->base.is_valid() && p_script->base->is_valid()) {
if (!p_script->base->doc.name.is_empty()) {
doc.inherits = p_script->base->doc.name;
} else {
doc.inherits = p_script->base->get_instance_base_type();
}
} else if (p_script->native.is_valid()) {
doc.inherits = p_script->native->get_name();
// See GH-105926. Evaluate the doc name of the base class instead of using `p_script->base->doc.name`
// to avoid load/compile order issues in case of complex circular dependencies.
doc.inherits = _get_gdscript_name(p_script->base.ptr());
} else {
doc.inherits = p_script->get_instance_base_type();
}
doc.brief_description = p_class->doc_data.brief;
modules/gdscript/editor/gdscript_docgen.h
+3
View File
@@ -40,8 +40,11 @@ class GDScriptDocGen {
static String _get_script_name(const String &p_path);
static String _get_class_name(const GDP::ClassNode &p_class);
static String _get_gdscript_name(const GDScript *p_script);
static void _doctype_from_gdtype(const GDType &p_gdtype, String &r_type, String &r_enum, bool p_is_return = false);
static String _docvalue_from_variant(const Variant &p_variant, int p_recursion_level = 1);
static void _generate_docs(GDScript *p_script, const GDP::ClassNode *p_class);
public: