diff options
| author | Andy Maloney <asmaloney@gmail.com> | 2022-08-12 12:07:53 -0400 |
|---|---|---|
| committer | Andy Maloney <asmaloney@gmail.com> | 2022-08-12 12:07:53 -0400 |
| commit | ea2192b99ea0a56559687a3e1b1a9d9f32518132 (patch) | |
| tree | e8593415d7d5e13111f0c72432ec556784999943 /doc/classes/EngineDebugger.xml | |
| parent | 22bb15cde52b2b0623907c889be2c71227d0258e (diff) | |
[doc] Use "param" instead of "code" to refer to parameters (6)
Diffstat (limited to 'doc/classes/EngineDebugger.xml')
| -rw-r--r-- | doc/classes/EngineDebugger.xml | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/classes/EngineDebugger.xml b/doc/classes/EngineDebugger.xml index c3e76b8cad..176bc1f135 100644 --- a/doc/classes/EngineDebugger.xml +++ b/doc/classes/EngineDebugger.xml @@ -41,7 +41,7 @@ <param index="0" name="name" type="StringName" /> <param index="1" name="data" type="Array" /> <description> - Calls the [code]add[/code] callable of the profiler with given [code]name[/code] and [code]data[/code]. + Calls the [code]add[/code] callable of the profiler with given [param name] and [param data]. </description> </method> <method name="profiler_enable"> @@ -50,7 +50,7 @@ <param index="1" name="enable" type="bool" /> <param index="2" name="arguments" type="Array" default="[]" /> <description> - Calls the [code]toggle[/code] callable of the profiler with given [code]name[/code] and [code]arguments[/code]. Enables/Disables the same profiler depending on [code]enable[/code] argument. + Calls the [code]toggle[/code] callable of the profiler with given [param name] and [param arguments]. Enables/Disables the same profiler depending on [code]enable[/code] argument. </description> </method> <method name="register_message_capture"> @@ -58,7 +58,7 @@ <param index="0" name="name" type="StringName" /> <param index="1" name="callable" type="Callable" /> <description> - Registers a message capture with given [code]name[/code]. If [code]name[/code] is "my_message" then messages starting with "my_message:" will be called with the given callable. + Registers a message capture with given [param name]. If [param name] is "my_message" then messages starting with "my_message:" will be called with the given callable. Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code]. </description> </method> @@ -67,7 +67,7 @@ <param index="0" name="name" type="StringName" /> <param index="1" name="profiler" type="EngineProfiler" /> <description> - Registers a profiler with the given [code]name[/code]. See [EngineProfiler] for more information. + Registers a profiler with the given [param name]. See [EngineProfiler] for more information. </description> </method> <method name="send_message"> @@ -75,21 +75,21 @@ <param index="0" name="message" type="String" /> <param index="1" name="data" type="Array" /> <description> - Sends a message with given [code]message[/code] and [code]data[/code] array. + Sends a message with given [param message] and [param data] array. </description> </method> <method name="unregister_message_capture"> <return type="void" /> <param index="0" name="name" type="StringName" /> <description> - Unregisters the message capture with given [code]name[/code]. + Unregisters the message capture with given [param name]. </description> </method> <method name="unregister_profiler"> <return type="void" /> <param index="0" name="name" type="StringName" /> <description> - Unregisters a profiler with given [code]name[/code]. + Unregisters a profiler with given [param name]. </description> </method> </methods> |