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

DocData: Skip language-specific ClassDoc without methods/constants 

Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.

(cherry picked from commit ba0db95909)
This commit is contained in:
Rémi Verschelde 2020-06-17 15:06:13 +02:00
parent dc7f555783
commit bf913d6917
8 changed files with 16 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/@GlobalScope.xml
View File

@ -30,6 +30,9 @@
<member name="Geometry" type="Geometry" setter="" getter="">
The [Geometry] singleton.
</member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
The [GodotSharp] singleton.
</member>
<member name="IP" type="IP" setter="" getter="">
The [IP] singleton.
</member>

17
editor/doc/doc_data.cpp
View File

@ -643,7 +643,9 @@ void DocData::generate(bool p_basic_types) {
}
}
//built in script reference
// Built-in script reference.
// We only add a doc entry for languages which actually define any built-in
// methods or constants.
{
@ -651,12 +653,11 @@ void DocData::generate(bool p_basic_types) {
ScriptLanguage *lang = ScriptServer::get_language(i);
String cname = "@" + lang->get_name();
class_list[cname] = ClassDoc();
ClassDoc &c = class_list[cname];
ClassDoc c;
c.name = cname;
// Get functions.
List<MethodInfo> minfo;
lang->get_public_functions(&minfo);
for (List<MethodInfo>::Element *E = minfo.front(); E; E = E->next()) {
@ -690,6 +691,7 @@ void DocData::generate(bool p_basic_types) {
c.methods.push_back(md);
}
// Get constants.
List<Pair<String, Variant> > cinfo;
lang->get_public_constants(&cinfo);
@ -700,6 +702,13 @@ void DocData::generate(bool p_basic_types) {
cd.value = E->get().second;
c.constants.push_back(cd);
}
// Skip adding the lang if it doesn't expose anything (e.g. C#).
if (c.methods.empty() && c.constants.empty()) {
continue;
}
class_list[cname] = c;
}
}
}

1
modules/gdnative/config.py
View File

@ -8,7 +8,6 @@ def configure(env):
def get_doc_classes():
return [
"@NativeScript",
"ARVRInterfaceGDNative",
"GDNative",
"GDNativeLibrary",

13
modules/gdnative/doc_classes/@NativeScript.xml
View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="@NativeScript" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

1
modules/mono/config.py
View File

@ -57,7 +57,6 @@ def configure(env):
def get_doc_classes():
return [
"@C#",
"CSharpScript",
"GodotSharp",
]

13
modules/mono/doc_classes/@C#.xml
View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="@C#" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

1
modules/visual_script/config.py
View File

@ -8,7 +8,6 @@ def configure(env):
def get_doc_classes():
return [
"@VisualScript",
"VisualScriptBasicTypeConstant",
"VisualScriptBuiltinFunc",
"VisualScriptClassConstant",

15
modules/visual_script/doc_classes/@VisualScript.xml
View File

@ -1,15 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="@VisualScript" version="3.2">
<brief_description>
Built-in visual script functions.
</brief_description>
<description>
A list of built-in visual script functions, see [VisualScriptBuiltinFunc] and [VisualScript].
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>