asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Mono/C#: Fix comment generation for non-constant param default

Browse source 
- Generate the comment for the param, even if the method has no description.
- Generate the comment outside the <summary> element.
This commit is contained in:
Ignacio Etcheverry 2020-01-02 18:09:59 +01:00
parent f3aa793ba3
commit c1ff3ef9e8
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
modules/mono/editor/bindings_generator.cpp
View file

@ -1602,7 +1602,7 @@ Error BindingsGenerator::_generate_cs_method(const BindingsGenerator::TypeInterf
// Apparently the name attribute must not include the @ // Apparently the name attribute must not include the @
String param_tag_name = iarg.name.begins_with("@") ? iarg.name.substr(1, iarg.name.length()) : iarg.name; String param_tag_name = iarg.name.begins_with("@") ? iarg.name.substr(1, iarg.name.length()) : iarg.name;
default_args_doc.append(INDENT2 "/// <param name=\"" + param_tag_name + "\">If the parameter is null, then the default value is " + def_arg + "</param>\n"); default_args_doc.append(MEMBER_BEGIN "/// <param name=\"" + param_tag_name + "\">If the parameter is null, then the default value is " + def_arg + "</param>");
} else { } else {
icall_params += arg_type->cs_in.empty() ? iarg.name : sformat(arg_type->cs_in, iarg.name); icall_params += arg_type->cs_in.empty() ? iarg.name : sformat(arg_type->cs_in, iarg.name);
} }
@ -1621,7 +1621,7 @@ Error BindingsGenerator::_generate_cs_method(const BindingsGenerator::TypeInterf
String xml_summary = bbcode_to_xml(fix_doc_description(p_imethod.method_doc->description), &p_itype); String xml_summary = bbcode_to_xml(fix_doc_description(p_imethod.method_doc->description), &p_itype);
Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>(); Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>();
if (summary_lines.size() || default_args_doc.get_string_length()) { if (summary_lines.size()) {
p_output.append(MEMBER_BEGIN "/// <summary>\n"); p_output.append(MEMBER_BEGIN "/// <summary>\n");
for (int i = 0; i < summary_lines.size(); i++) { for (int i = 0; i < summary_lines.size(); i++) {
@ -1630,11 +1630,14 @@ Error BindingsGenerator::_generate_cs_method(const BindingsGenerator::TypeInterf
p_output.append("\n"); p_output.append("\n");
} }
p_output.append(default_args_doc.as_string());
p_output.append(INDENT2 "/// </summary>"); p_output.append(INDENT2 "/// </summary>");
} }
} }
if (default_args_doc.get_string_length()) {
p_output.append(default_args_doc.as_string());
}
if (!p_imethod.is_internal) { if (!p_imethod.is_internal) {
p_output.append(MEMBER_BEGIN "[GodotMethod(\""); p_output.append(MEMBER_BEGIN "[GodotMethod(\"");
p_output.append(p_imethod.name); p_output.append(p_imethod.name);