godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Link exposed set/getters in property descriptions 

(cherry picked from commit ea07acb877)
This commit is contained in:
Tomasz Chabora 2020-05-21 21:07:44 +02:00 committed by Rémi Verschelde
parent bf9df88a7c
commit 202ca3ce7f
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
editor/editor_help.cpp
View File

@ -1025,6 +1025,11 @@ void EditorHelp::_update_doc() {
class_desc->pop(); // font class_desc->pop(); // font
class_desc->pop(); // cell class_desc->pop(); // cell
Map<String, DocData::MethodDoc> method_map;
for (int j = 0; j < methods.size(); j++) {
method_map[methods[j].name] = methods[j];
}
if (cd.properties[i].setter != "") { if (cd.properties[i].setter != "") {
class_desc->push_cell(); class_desc->push_cell();
@ -1033,7 +1038,14 @@ void EditorHelp::_update_doc() {
class_desc->push_cell(); class_desc->push_cell();
class_desc->push_font(doc_code_font); class_desc->push_font(doc_code_font);
class_desc->push_color(text_color); class_desc->push_color(text_color);
if (method_map[cd.properties[i].setter].arguments.size() > 1) {
// Setters with additional arguments are exposed in the method list, so we link them here for quick access.
class_desc->push_meta("@method " + cd.properties[i].setter);
class_desc->add_text(cd.properties[i].setter + TTR("(value)")); class_desc->add_text(cd.properties[i].setter + TTR("(value)"));
class_desc->pop();
} else {
class_desc->add_text(cd.properties[i].setter + TTR("(value)"));
}
class_desc->pop(); // color class_desc->pop(); // color
class_desc->push_color(comment_color); class_desc->push_color(comment_color);
class_desc->add_text(" setter"); class_desc->add_text(" setter");
@ -1051,7 +1063,14 @@ void EditorHelp::_update_doc() {
class_desc->push_cell(); class_desc->push_cell();
class_desc->push_font(doc_code_font); class_desc->push_font(doc_code_font);
class_desc->push_color(text_color); class_desc->push_color(text_color);
if (method_map[cd.properties[i].getter].arguments.size() > 0) {
// Getters with additional arguments are exposed in the method list, so we link them here for quick access.
class_desc->push_meta("@method " + cd.properties[i].getter);
class_desc->add_text(cd.properties[i].getter + "()"); class_desc->add_text(cd.properties[i].getter + "()");
class_desc->pop();
} else {
class_desc->add_text(cd.properties[i].getter + "()");
}
class_desc->pop(); //color class_desc->pop(); //color
class_desc->push_color(comment_color); class_desc->push_color(comment_color);
class_desc->add_text(" getter"); class_desc->add_text(" getter");