Skip to content

Commit

Permalink
Add more context to Format etc documentation (#2079)
Browse files Browse the repository at this point in the history
  • Loading branch information
sapphonie authored Nov 6, 2023
1 parent 4b2d8b5 commit d4da21b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions plugins/include/string.inc
Original file line number Diff line number Diff line change
Expand Up @@ -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).
*
* @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 ... Variable number of format parameters.
* @return Number of characters written to the buffer,
Expand All @@ -155,7 +156,8 @@ native int Format(char[] buffer, int maxlength, const char[] format, any ...);
* check is removed, it is slightly faster.
*
* @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 ... Variable number of format parameters.
* @return Number of characters written to the buffer,
Expand All @@ -170,7 +172,8 @@ native int FormatEx(char[] buffer, int maxlength, const char[] format, any ...);
* implementing your own variable argument functions.
*
* @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 varpos Argument number which contains the '...' symbol.
* Note: Arguments start at 1.
Expand Down

0 comments on commit d4da21b

Please sign in to comment.