diff options
author | alberth <alberth@openttd.org> | 2009-07-25 07:49:49 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2009-07-25 07:49:49 +0000 |
commit | 59c48fee8bda56a788310f6d83b99087d518fb0f (patch) | |
tree | 361d0852066b29d2a96ca1cd2a2466931b037014 /src/strings.cpp | |
parent | 63f2da749283621907039d551aaeb1294539fc92 (diff) | |
download | openttd-59c48fee8bda56a788310f6d83b99087d518fb0f.tar.xz |
(svn r16946) -Doc: Adding docs for some string parameter manipulation functions.
Diffstat (limited to 'src/strings.cpp')
-rw-r--r-- | src/strings.cpp | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/strings.cpp b/src/strings.cpp index 25699ad07..4cbe06df3 100644 --- a/src/strings.cpp +++ b/src/strings.cpp @@ -35,8 +35,8 @@ #include "table/strings.h" #include "table/control_codes.h" -DynamicLanguages _dynlang; -uint64 _decode_parameters[20]; +DynamicLanguages _dynlang; ///< Language information of the program. +uint64 _decode_parameters[20]; ///< Global array of string parameters. To access, use #SetDParam. static char *StationGetSpecialString(char *buff, int x, const char *last); static char *GetSpecialTownNameString(char *buff, int ind, uint32 seed, const char *last); @@ -171,6 +171,10 @@ void SetDParamStr(uint n, const char *str) SetDParam(n, (uint64)(size_t)str); } +/** + * Shift the string parameters in the global string parameter array by \a amount positions, making room at the beginning. + * @param amount Number of positions to shift. + */ void InjectDParam(uint amount) { assert((uint)amount < lengthof(_decode_parameters)); |