Fix vault.inc documentation (#550)
* Fix vault.inc documentation * Add missing * * Fix typos
This commit is contained in:
parent
b4927bfb1f
commit
579a83c2a4
|
@ -16,16 +16,45 @@
|
||||||
#endif
|
#endif
|
||||||
#define _vault_included
|
#define _vault_included
|
||||||
|
|
||||||
/* Reads a data from given key.
|
/**
|
||||||
* If len is set to zero then get_vaultdata
|
* Reads data from a given key.
|
||||||
* returns value as an number. */
|
*
|
||||||
|
*
|
||||||
|
* @param key Key to get the value from
|
||||||
|
* @param data Buffer to copy the value to
|
||||||
|
* @param len Buffer size. If len is set to 0 then the function will
|
||||||
|
* return the value as a number
|
||||||
|
*
|
||||||
|
* @return If len is not 0 the function will return the number of characters written.
|
||||||
|
If len is 0 the function will return the numerical value associated with the key.
|
||||||
|
*/
|
||||||
native get_vaultdata(const key[], data[] = "", len = 0);
|
native get_vaultdata(const key[], data[] = "", len = 0);
|
||||||
|
|
||||||
/* Sets a data under given key. */
|
|
||||||
|
/**
|
||||||
|
* Sets data for a given key.
|
||||||
|
*
|
||||||
|
* @param key Key to set the value for
|
||||||
|
* @param data Data to set for the given key
|
||||||
|
*
|
||||||
|
* @noreturn
|
||||||
|
*/
|
||||||
native set_vaultdata(const key[], const data[] = "");
|
native set_vaultdata(const key[], const data[] = "");
|
||||||
|
|
||||||
/* Removes a key from vault.*/
|
/**
|
||||||
|
* Removes a key and its data from the vault.
|
||||||
|
*
|
||||||
|
* @param key Key to remove
|
||||||
|
*
|
||||||
|
* @noreturn
|
||||||
|
*/
|
||||||
native remove_vaultdata(const key[]);
|
native remove_vaultdata(const key[]);
|
||||||
|
|
||||||
/* Checks if a key exists in the vault.*/
|
/**
|
||||||
|
* Checks if a key exists in the vault.
|
||||||
|
*
|
||||||
|
* @param key Key to check
|
||||||
|
*
|
||||||
|
* @return 1 if an entry was found, 0 otherwise.
|
||||||
|
*/
|
||||||
native vaultdata_exists(const key[]);
|
native vaultdata_exists(const key[]);
|
||||||
|
|
Loading…
Reference in New Issue
Block a user