Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix GDScript docs not updating when modified externally #97710

Merged
merged 1 commit into from
Oct 2, 2024
+11 −14
Merged

Fix GDScript docs not updating when modified externally #97710

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions editor/editor_file_system.cpp
View file
Original file line number Diff line number Diff line change
@@ -2089,12 +2089,11 @@ void EditorFileSystem::_update_script_documentation() {
// return the last loaded version of the script (without the modifications).
scr->reload_from_file();
}
Vector<DocData::ClassDoc> docs = scr->get_documentation();
for (int j = 0; j < docs.size(); j++) {
EditorHelp::get_doc_data()->add_doc(docs[j]);
for (const DocData::ClassDoc &cd : scr->get_documentation()) {
EditorHelp::get_doc_data()->add_doc(cd);
if (!first_scan) {
// Update the documentation in the Script Editor if it is open.
ScriptEditor::get_singleton()->update_doc(docs[j].name);
ScriptEditor::get_singleton()->update_doc(cd.name);
}
}
}
18 changes: 8 additions & 10 deletions editor/plugins/script_editor_plugin.cpp
View file
Original file line number Diff line number Diff line change
@@ -2798,6 +2798,8 @@ void ScriptEditor::_reload_scripts(bool p_refresh_only) {
scr->set_source_code(rel_scr->get_source_code());
scr->set_last_modified_time(rel_scr->get_last_modified_time());
scr->reload(true);

update_docs_from_script(scr);
}

Ref<JSON> json = edited_res;
@@ -3644,23 +3646,19 @@ void ScriptEditor::update_doc(const String &p_name) {
void ScriptEditor::clear_docs_from_script(const Ref<Script> &p_script) {
ERR_FAIL_COND(p_script.is_null());

Vector<DocData::ClassDoc> documentations = p_script->get_documentation();
for (int j = 0; j < documentations.size(); j++) {
const DocData::ClassDoc &doc = documentations.get(j);
if (EditorHelp::get_doc_data()->has_doc(doc.name)) {
EditorHelp::get_doc_data()->remove_doc(doc.name);
for (const DocData::ClassDoc &cd : p_script->get_documentation()) {
if (EditorHelp::get_doc_data()->has_doc(cd.name)) {
EditorHelp::get_doc_data()->remove_doc(cd.name);
}
}
}

void ScriptEditor::update_docs_from_script(const Ref<Script> &p_script) {
ERR_FAIL_COND(p_script.is_null());

Vector<DocData::ClassDoc> documentations = p_script->get_documentation();
for (int j = 0; j < documentations.size(); j++) {
const DocData::ClassDoc &doc = documentations.get(j);
EditorHelp::get_doc_data()->add_doc(doc);
update_doc(doc.name);
for (const DocData::ClassDoc &cd : p_script->get_documentation()) {
EditorHelp::get_doc_data()->add_doc(cd);
update_doc(cd.name);
}
}