Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

nvault.inc documentation fix (#501)

Browse Source 
* Update lang.inc

* Update lang.inc

* Update nvault.inc

* Update nvault.inc
This commit is contained in:
OciXCrom 2018-07-24 15:36:31 +02:00 committed by Vincent Herbet
parent 57abc4a1c5
commit 4ae31f6f26
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
plugins/include/nvault.inc
View File

@ -37,7 +37,7 @@
native nvault_open(const name[]); native nvault_open(const name[]);
/** /**
* Retrieves a value from the given key * Retrieves a value from the given key.
* *
* @note An example of retrieving a string: * @note An example of retrieving a string:
* nvault_get(vaultHandle, "myKey", myString, charsmax(myString)); * nvault_get(vaultHandle, "myKey", myString, charsmax(myString));
@ -50,13 +50,16 @@ native nvault_open(const name[]);
* vault and copies it to the third argument, up to * vault and copies it to the third argument, up to
* 4th argument characters. * 4th argument characters.
* *
* @noreturn * @return Result as integer if only the first two arguments
* of the function are used.
* 1 if only the first three arguments are used.
* String length if all four parameters are used.
* @error On invalid vault handle. * @error On invalid vault handle.
*/ */
native nvault_get(vault, const key[], any:...); native nvault_get(vault, const key[], any:...);
/** /**
* Retrieves full information about a vault entry * Retrieves full information about a vault entry.
* *
* @param vault A vault handle returned from nvault_open() * @param vault A vault handle returned from nvault_open()
* @param key A key to get information from * @param key A key to get information from
@ -109,7 +112,7 @@ native nvault_pset(vault, const key[], const value[]);
* @param start The timestamp to start erasing from * @param start The timestamp to start erasing from
* @param end The timestamp to erase to * @param end The timestamp to erase to
* *
* @noreturn * @return Number of erased values.
* @error On invalid vault handle. * @error On invalid vault handle.
*/ */
native nvault_prune(vault, start, end); native nvault_prune(vault, start, end);