diff options
Diffstat (limited to 'doc/classes/CryptoKey.xml')
| -rw-r--r-- | doc/classes/CryptoKey.xml | 40 |
1 files changed, 14 insertions, 26 deletions
diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml index 410c2262f9..afe2c6b301 100644 --- a/doc/classes/CryptoKey.xml +++ b/doc/classes/CryptoKey.xml @@ -12,52 +12,40 @@ </tutorials> <methods> <method name="is_public_only" qualifiers="const"> - <return type="bool"> - </return> + <return type="bool" /> <description> Return [code]true[/code] if this CryptoKey only has the public part, and not the private one. </description> </method> <method name="load"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="public_only" type="bool" default="false"> - </argument> + <return type="int" enum="Error" /> + <argument index="0" name="path" type="String" /> + <argument 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 should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. + [b]Note[/b]: [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. </description> </method> <method name="load_from_string"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="string_key" type="String"> - </argument> - <argument index="1" name="public_only" type="bool" default="false"> - </argument> + <return type="int" enum="Error" /> + <argument index="0" name="string_key" type="String" /> + <argument 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"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="public_only" type="bool" default="false"> - </argument> + <return type="int" enum="Error" /> + <argument index="0" name="path" type="String" /> + <argument 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 should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. + [b]Note[/b]: [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. </description> </method> <method name="save_to_string"> - <return type="String"> - </return> - <argument index="0" name="public_only" type="bool" default="false"> - </argument> + <return type="String" /> + <argument 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> |