UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add more context to Format etc documentation (#2079)

Browse Source
This commit is contained in:
sappho 2023-11-06 11:07:00 -05:00 committed by GitHub
parent 4b2d8b53fa
commit d4da21b07f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
plugins/include/string.inc
View File

@ -140,7 +140,8 @@ stock int StrCopy(char[] dest, int destLen, const char[] source)
* Formats a string according to the SourceMod format rules (see documentation). * Formats a string according to the SourceMod format rules (see documentation).
* *
* @param buffer Destination string buffer. * @param buffer Destination string buffer.
* @param maxlength Maximum length of output string buffer. * @param maxlength Maximum length of output string buffer,
* including the null terminator.
* @param format Formatting rules. * @param format Formatting rules.
* @param ... Variable number of format parameters. * @param ... Variable number of format parameters.
* @return Number of characters written to the buffer, * @return Number of characters written to the buffer,
@ -155,7 +156,8 @@ native int Format(char[] buffer, int maxlength, const char[] format, any ...);
* check is removed, it is slightly faster. * check is removed, it is slightly faster.
* *
* @param buffer Destination string buffer. * @param buffer Destination string buffer.
* @param maxlength Maximum length of output string buffer. * @param maxlength Maximum length of output string buffer,
* including the null terminator.
* @param format Formatting rules. * @param format Formatting rules.
* @param ... Variable number of format parameters. * @param ... Variable number of format parameters.
* @return Number of characters written to the buffer, * @return Number of characters written to the buffer,
@ -170,7 +172,8 @@ native int FormatEx(char[] buffer, int maxlength, const char[] format, any ...);
* implementing your own variable argument functions. * implementing your own variable argument functions.
* *
* @param buffer Destination string buffer. * @param buffer Destination string buffer.
* @param maxlength Maximum length of output string buffer. * @param maxlength Maximum length of output string buffer,
* including the null terminator.
* @param format Formatting rules. * @param format Formatting rules.
* @param varpos Argument number which contains the '...' symbol. * @param varpos Argument number which contains the '...' symbol.
* Note: Arguments start at 1. * Note: Arguments start at 1.