godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-16 14:00:40 +00:00
Code Releases Wiki Activity

Make documentation ignore undocumented private signals

Browse Source
This commit is contained in:
Grublady
2025-04-23 12:45:19 -04:00
parent 1696ab0cb6
commit e2ccf9b7c4
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
editor/editor_help.cpp
View File

@@ -1512,15 +1512,27 @@ void EditorHelp::_update_doc() {
cd.signals.sort(); cd.signals.sort();
} }
class_desc->add_newline(); bool header_added = false;
class_desc->add_newline();
section_line.push_back(Pair<String, int>(TTR("Signals"), class_desc->get_paragraph_count() - 2));
_push_title_font();
class_desc->add_text(TTR("Signals"));
_pop_title_font();
for (const DocData::MethodDoc &signal : cd.signals) { for (const DocData::MethodDoc &signal : cd.signals) {
// Ignore undocumented private.
const bool is_documented = signal.is_deprecated || signal.is_experimental || !signal.description.strip_edges().is_empty();
if (!is_documented && signal.name.begins_with("_")) {
continue;
}
if (!header_added) {
header_added = true;
class_desc->add_newline();
class_desc->add_newline();
section_line.push_back(Pair<String, int>(TTR("Signals"), class_desc->get_paragraph_count() - 2));
_push_title_font();
class_desc->add_text(TTR("Signals"));
_pop_title_font();
}
class_desc->add_newline(); class_desc->add_newline();
class_desc->add_newline(); class_desc->add_newline();