Skip to content

Commit e2ccf9b

Browse files
committed
Make documentation ignore undocumented private signals
1 parent 1696ab0 commit e2ccf9b

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

editor/editor_help.cpp

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1512,15 +1512,27 @@ void EditorHelp::_update_doc() {
15121512
cd.signals.sort();
15131513
}
15141514

1515-
class_desc->add_newline();
1516-
class_desc->add_newline();
1517-
1518-
section_line.push_back(Pair<String, int>(TTR("Signals"), class_desc->get_paragraph_count() - 2));
1519-
_push_title_font();
1520-
class_desc->add_text(TTR("Signals"));
1521-
_pop_title_font();
1515+
bool header_added = false;
15221516

15231517
for (const DocData::MethodDoc &signal : cd.signals) {
1518+
// Ignore undocumented private.
1519+
const bool is_documented = signal.is_deprecated || signal.is_experimental || !signal.description.strip_edges().is_empty();
1520+
if (!is_documented && signal.name.begins_with("_")) {
1521+
continue;
1522+
}
1523+
1524+
if (!header_added) {
1525+
header_added = true;
1526+
1527+
class_desc->add_newline();
1528+
class_desc->add_newline();
1529+
1530+
section_line.push_back(Pair<String, int>(TTR("Signals"), class_desc->get_paragraph_count() - 2));
1531+
_push_title_font();
1532+
class_desc->add_text(TTR("Signals"));
1533+
_pop_title_font();
1534+
}
1535+
15241536
class_desc->add_newline();
15251537
class_desc->add_newline();
15261538

0 commit comments

Comments
 (0)