Skip to content

Commit

Permalink
nvault.inc documentation fix (#501)
Browse files Browse the repository at this point in the history
* Update lang.inc

* Update lang.inc

* Update nvault.inc

* Update nvault.inc
  • Loading branch information
OciXCrom authored and Arkshine committed Jul 24, 2018
1 parent 57abc4a commit 4ae31f6
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions plugins/include/nvault.inc
Expand Up @@ -37,7 +37,7 @@
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:
* nvault_get(vaultHandle, "myKey", myString, charsmax(myString));
Expand All @@ -50,13 +50,16 @@ native nvault_open(const name[]);
* vault and copies it to the third argument, up to
* 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.
*/
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 key A key to get information from
Expand Down Expand Up @@ -109,7 +112,7 @@ native nvault_pset(vault, const key[], const value[]);
* @param start The timestamp to start erasing from
* @param end The timestamp to erase to
*
* @noreturn
* @return Number of erased values.
* @error On invalid vault handle.
*/
native nvault_prune(vault, start, end);
Expand Down

0 comments on commit 4ae31f6

Please sign in to comment.