godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-06 10:11:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Proofread and improve the whole class reference

Browse Source 
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
This commit is contained in:
Hugo Locurcio
2019-06-22 01:04:47 +02:00
parent 538c8eec15
commit f7f6115f76
330 changed files with 2585 additions and 2474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/classes/EditorSettings.xml
View File

@@ -4,7 +4,7 @@
Object that holds the project-independent editor settings.
</brief_description>
<description>
Object that holds the project-independent editor settings. These settings are generally visible in the Editor Settings menu.
Object that holds the project-independent editor settings. These settings are generally visible in the [b]Editor &gt; Editor Settings[/b] menu.
Accessing the settings is done by using the regular [Object] API, such as:
[codeblock]
settings.set(prop,value)
@@ -21,8 +21,8 @@
<argument index="0" name="info" type="Dictionary">
</argument>
<description>
Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String].
Example:
Adds a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see [code]TYPE_*[/code] in [@GlobalScope]), and optionally hint:[int](see [code]PROPERTY_HINT_*[/code] in [@GlobalScope]), hint_string:[String].
[b]Example:[/b]
[codeblock]
editor_settings.set("category/property_name", 0)
@@ -50,7 +50,7 @@
<return type="PoolStringArray">
</return>
<description>
Get the list of favorite files and directories for this project.
Gets the list of favorite files and directories for this project.
</description>
</method>
<method name="get_project_metadata" qualifiers="const">
@@ -69,14 +69,14 @@
<return type="String">
</return>
<description>
Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved.
Gets the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved.
</description>
</method>
<method name="get_recent_dirs" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
Get the list of recently visited folders in the file dialog for this project.
Gets the list of recently visited folders in the file dialog for this project.
</description>
</method>
<method name="get_setting" qualifiers="const">
@@ -91,9 +91,9 @@
<return type="String">
</return>
<description>
Get the global settings path for the engine. Inside this path you can find some standard paths such as:
settings/tmp - used for temporary storage of files
settings/templates - where export templates are located
Gets the global settings path for the engine. Inside this path, you can find some standard paths such as:
[code]settings/tmp[/code] - Used for temporary storage of files
[code]settings/templates[/code] - Where export templates are located
</description>
</method>
<method name="has_setting" qualifiers="const">
@@ -126,7 +126,7 @@
<argument index="0" name="dirs" type="PoolStringArray">
</argument>
<description>
Set the list of favorite files and directories for this project.
Sets the list of favorite files and directories for this project.
</description>
</method>
<method name="set_initial_value">
@@ -159,7 +159,7 @@
<argument index="0" name="dirs" type="PoolStringArray">
</argument>
<description>
Set the list of recently visited folders in the file dialog for this project.
Sets the list of recently visited folders in the file dialog for this project.
</description>
</method>
<method name="set_setting">