Explorar el Código

DocData: Skip language-specific ClassDoc without methods/constants

Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.
Rémi Verschelde hace 5 años
padre
commit
ba0db95909

+ 3 - 0
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>

+ 9 - 9
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>

+ 0 - 14
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>

+ 5 - 5
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>

+ 13 - 4
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;
 		}
 	}
 }

+ 0 - 1
modules/gdnative/config.py

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

+ 0 - 13
modules/gdnative/doc_classes/@NativeScript.xml

@@ -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>

+ 0 - 1
modules/mono/config.py

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

+ 0 - 13
modules/mono/doc_classes/@C#.xml

@@ -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>

+ 0 - 1
modules/visual_script/config.py

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

+ 0 - 15
modules/visual_script/doc_classes/@VisualScript.xml

@@ -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>