瀏覽代碼

Merge pull request #78571 from MewPurPur/include-extension-info

Document file extensions of GDScript, CSharpScript, and Shader
Rémi Verschelde 2 年之前
父節點
當前提交
af16013905
共有 3 個文件被更改,包括 6 次插入5 次删除
  1. 4 3
      doc/classes/Shader.xml
  2. 1 1
      modules/gdscript/doc_classes/GDScript.xml
  3. 1 1
      modules/mono/doc_classes/CSharpScript.xml

+ 4 - 3
doc/classes/Shader.xml

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="Shader" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
 	<brief_description>
-		A custom shader program.
+		A shader implemented in the Godot shading language.
 	</brief_description>
 	<description>
-		This class allows you to define a custom shader program that can be used by a [ShaderMaterial]. Shaders allow you to write your own custom behavior for rendering objects or updating particle information. For a detailed explanation and usage, please see the tutorials linked below.
+		A custom shader program implemented in the Godot shading language, saved with the [code].gdshader[/code] extension.
+		This class is used by a [ShaderMaterial] and allows you to write your own custom behavior for rendering visual items or updating particle information. For a detailed explanation and usage, please see the tutorials linked below.
 	</description>
 	<tutorials>
 		<link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link>
@@ -23,7 +24,7 @@
 		<method name="get_mode" qualifiers="const">
 			<return type="int" enum="Shader.Mode" />
 			<description>
-				Returns the shader mode for the shader, either [constant MODE_CANVAS_ITEM], [constant MODE_SPATIAL] or [constant MODE_PARTICLES].
+				Returns the shader mode for the shader.
 			</description>
 		</method>
 		<method name="get_shader_uniform_list">

+ 1 - 1
modules/gdscript/doc_classes/GDScript.xml

@@ -4,7 +4,7 @@
 		A script implemented in the GDScript programming language.
 	</brief_description>
 	<description>
-		A script implemented in the GDScript programming language. The script extends the functionality of all objects that instantiate it.
+		A script implemented in the GDScript programming language, saved with the [code].gd[/code] extension. The script extends the functionality of all objects that instantiate it.
 		Calling [method new] creates a new instance of the script. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
 		If you are looking for GDScript's built-in functions, see [@GDScript] instead.
 	</description>

+ 1 - 1
modules/mono/doc_classes/CSharpScript.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="CSharpScript" inherits="Script" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
 	<brief_description>
-		A script implemented in the C# programming language (Mono-enabled builds only).
+		A script implemented in the C# programming language, saved with the [code].cs[/code] extension (Mono-enabled builds only).
 	</brief_description>
 	<description>
 		This class represents a C# script. It is the C# equivalent of the [GDScript] class and is only available in Mono-enabled Godot builds.