nick/godot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/CryptoKey.xml
+7 -7
View File
@@ -18,8 +18,8 @@
</method>
<method name="load">
<return type="int" enum="Error" />
<argument index="0" name="path" type="String" />
<argument index="1" name="public_only" type="bool" default="false" />
<param index="0" name="path" type="String" />
<param index="1" name="public_only" type="bool" default="false" />
<description>
Loads a key from [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded.
[b]Note:[/b] [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise.
@@ -27,16 +27,16 @@
</method>
<method name="load_from_string">
<return type="int" enum="Error" />
<argument index="0" name="string_key" type="String" />
<argument index="1" name="public_only" type="bool" default="false" />
<param index="0" name="string_key" type="String" />
<param index="1" name="public_only" type="bool" default="false" />
<description>
Loads a key from the given [code]string[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded.
</description>
</method>
<method name="save">
<return type="int" enum="Error" />
<argument index="0" name="path" type="String" />
<argument index="1" name="public_only" type="bool" default="false" />
<param index="0" name="path" type="String" />
<param index="1" name="public_only" type="bool" default="false" />
<description>
Saves a key to the given [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be saved.
[b]Note:[/b] [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise.
@@ -44,7 +44,7 @@
</method>
<method name="save_to_string">
<return type="String" />
<argument index="0" name="public_only" type="bool" default="false" />
<param index="0" name="public_only" type="bool" default="false" />
<description>
Returns a string containing the key in PEM format. If [code]public_only[/code] is [code]true[/code], only the public key will be included.
</description>