summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-06-17 15:52:15 +0200
committerGitHub <noreply@github.com>2020-06-17 15:52:15 +0200
commit84e7552f83d8fb71a0fabb6bf6709f42401605d4 (patch)
tree9dec7b587da17d2beac94d8003a7874d7165e9dc
parent7cde0e4ab99e879428af38fd3f005524920c2ed4 (diff)
parentba0db95909a232e3f4d694294f077c9460ef00ce (diff)
Merge pull request #39622 from akien-mga/docdata-skip-empty-scripting-langs-builtins
DocData: Skip language-specific ClassDoc without methods/constants
-rw-r--r--doc/classes/@GlobalScope.xml3
-rw-r--r--doc/classes/InputMap.xml18
-rw-r--r--doc/classes/OS.xml14
-rw-r--r--doc/classes/RenderingServer.xml10
-rw-r--r--editor/doc_data.cpp17
-rw-r--r--modules/gdnative/config.py1
-rw-r--r--modules/gdnative/doc_classes/@NativeScript.xml13
-rw-r--r--modules/mono/config.py1
-rw-r--r--modules/mono/doc_classes/@C#.xml13
-rw-r--r--modules/visual_script/config.py1
-rw-r--r--modules/visual_script/doc_classes/@VisualScript.xml15
11 files changed, 30 insertions, 76 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index 41811a48b1..9a28a0d085 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -33,6 +33,9 @@
<member name="Geometry3D" type="Geometry3D" setter="" getter="">
The [Geometry3D] singleton.
</member>
+ <member name="GodotSharp" type="GodotSharp" setter="" getter="">
+ The [GodotSharp] singleton.
+ </member>
<member name="IP" type="IP" setter="" getter="">
The [IP] singleton.
</member>
diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml
index 842c69de27..03212538c9 100644
--- a/doc/classes/InputMap.xml
+++ b/doc/classes/InputMap.xml
@@ -41,6 +41,15 @@
Removes all events from an action.
</description>
</method>
+ <method name="action_get_events">
+ <return type="Array">
+ </return>
+ <argument index="0" name="action" type="StringName">
+ </argument>
+ <description>
+ Returns an array of [InputEvent]s associated with a given action.
+ </description>
+ </method>
<method name="action_has_event">
<return type="bool">
</return>
@@ -95,15 +104,6 @@
Returns [code]true[/code] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior.
</description>
</method>
- <method name="action_get_events">
- <return type="Array">
- </return>
- <argument index="0" name="action" type="StringName">
- </argument>
- <description>
- Returns an array of [InputEvent]s associated with a given action.
- </description>
- </method>
<method name="get_actions">
<return type="Array">
</return>
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index b131d2728c..23473290c7 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -254,20 +254,6 @@
[b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows.
</description>
</method>
- <method name="get_system_time_msecs" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the epoch time of the operating system in milliseconds.
- </description>
- </method>
- <method name="get_system_time_secs" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the epoch time of the operating system in seconds.
- </description>
- </method>
<method name="get_tablet_driver_count" qualifiers="const">
<return type="int">
</return>
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index 516a16e053..8832c0ec4d 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -17,11 +17,6 @@
<tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/optimization/using_servers.html</link>
</tutorials>
- <members>
- <member name="render_loop_enabled" type="bool" setter="set_render_loop_enabled" getter="is_render_loop_enabled" default="true">
- If [code]false[/code], disables rendering completely, but the engine logic is still being processed. You can call [method force_draw] to draw a frame even with rendering disabled.
- </member>
- </members>
<methods>
<method name="black_bars_set_images">
<return type="void">
@@ -3014,6 +3009,11 @@
</description>
</method>
</methods>
+ <members>
+ <member name="render_loop_enabled" type="bool" setter="set_render_loop_enabled" getter="is_render_loop_enabled">
+ If [code]false[/code], disables rendering completely, but the engine logic is still being processed. You can call [method force_draw] to draw a frame even with rendering disabled.
+ </member>
+ </members>
<signals>
<signal name="frame_post_draw">
<description>
diff --git a/editor/doc_data.cpp b/editor/doc_data.cpp
index c52d91b03d..54acbe9559 100644
--- a/editor/doc_data.cpp
+++ b/editor/doc_data.cpp
@@ -662,18 +662,19 @@ 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.
{
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
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()) {
@@ -706,6 +707,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);
@@ -715,6 +717,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;
}
}
}
diff --git a/modules/gdnative/config.py b/modules/gdnative/config.py
index 4b997e4bfe..7603e7d69d 100644
--- a/modules/gdnative/config.py
+++ b/modules/gdnative/config.py
@@ -8,7 +8,6 @@ def configure(env):
def get_doc_classes():
return [
- "@NativeScript",
"XRInterfaceGDNative",
"GDNative",
"GDNativeLibrary",
diff --git a/modules/gdnative/doc_classes/@NativeScript.xml b/modules/gdnative/doc_classes/@NativeScript.xml
deleted file mode 100644
index 809b225e21..0000000000
--- a/modules/gdnative/doc_classes/@NativeScript.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="@NativeScript" version="4.0">
- <brief_description>
- </brief_description>
- <description>
- </description>
- <tutorials>
- </tutorials>
- <methods>
- </methods>
- <constants>
- </constants>
-</class>
diff --git a/modules/mono/config.py b/modules/mono/config.py
index 7980a86cb3..cd659057ef 100644
--- a/modules/mono/config.py
+++ b/modules/mono/config.py
@@ -57,7 +57,6 @@ def configure(env):
def get_doc_classes():
return [
- "@C#",
"CSharpScript",
"GodotSharp",
]
diff --git a/modules/mono/doc_classes/@C#.xml b/modules/mono/doc_classes/@C#.xml
deleted file mode 100644
index 83a7fbf02c..0000000000
--- a/modules/mono/doc_classes/@C#.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="@C#" version="4.0">
- <brief_description>
- </brief_description>
- <description>
- </description>
- <tutorials>
- </tutorials>
- <methods>
- </methods>
- <constants>
- </constants>
-</class>
diff --git a/modules/visual_script/config.py b/modules/visual_script/config.py
index bd459ca344..b15479797c 100644
--- a/modules/visual_script/config.py
+++ b/modules/visual_script/config.py
@@ -8,7 +8,6 @@ def configure(env):
def get_doc_classes():
return [
- "@VisualScript",
"VisualScriptBasicTypeConstant",
"VisualScriptBuiltinFunc",
"VisualScriptClassConstant",
diff --git a/modules/visual_script/doc_classes/@VisualScript.xml b/modules/visual_script/doc_classes/@VisualScript.xml
deleted file mode 100644
index a2b966bfbb..0000000000
--- a/modules/visual_script/doc_classes/@VisualScript.xml
+++ /dev/null
@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="@VisualScript" version="4.0">
- <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>