diff options
| author | rubidium <rubidium@openttd.org> | 2011-05-02 17:42:12 +0000 |
|---|---|---|
| committer | rubidium <rubidium@openttd.org> | 2011-05-02 17:42:12 +0000 |
| commit | fb5ecb94992e7febf4bc059cb6ec4a51f50c66b0 (patch) | |
| tree | 87956636c318baa8d5d8d62f13263c4f64dbe881 /src/core/string_compare_type.hpp | |
| parent | 4d5dbf51707c42c24eeafdb65016b079c54adcf2 (diff) | |
| download | openttd-fb5ecb94992e7febf4bc059cb6ec4a51f50c66b0.tar.xz | |
(svn r22411) -Document: another bunch of bits
Diffstat (limited to 'src/core/string_compare_type.hpp')
| -rw-r--r-- | src/core/string_compare_type.hpp | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/core/string_compare_type.hpp b/src/core/string_compare_type.hpp index 2bc018feb..77180747b 100644 --- a/src/core/string_compare_type.hpp +++ b/src/core/string_compare_type.hpp @@ -12,7 +12,14 @@ #ifndef STRING_COMPARE_TYPE_HPP #define STRING_COMPARE_TYPE_HPP +/** Comparator for strings. */ struct StringCompare { + /** + * Compare two strings. + * @param a The first string. + * @param b The second string. + * @return True is the first string is deemed "lower" than the second string. + */ bool operator () (const char *a, const char *b) const { return strcmp(a, b) < 0; |