aboutsummaryrefslogtreecommitdiff
path: root/engines
diff options
context:
space:
mode:
authorMax Horn2011-06-17 12:11:40 +0200
committerMax Horn2011-06-17 14:21:18 +0200
commit7c44582bb74bc3386040788b53d3ba27505723e7 (patch)
tree878f59c1b9ba79248d239261d1999e1cd8b15dc0 /engines
parentc2bbab4fec7fa568d45984177035f2ef15da075b (diff)
downloadscummvm-rg350-7c44582bb74bc3386040788b53d3ba27505723e7.tar.gz
scummvm-rg350-7c44582bb74bc3386040788b53d3ba27505723e7.tar.bz2
scummvm-rg350-7c44582bb74bc3386040788b53d3ba27505723e7.zip
ENGINES: Update GameDescriptor::updateDesc docs to match reality
Diffstat (limited to 'engines')
-rw-r--r--engines/game.cpp3
-rw-r--r--engines/game.h4
2 files changed, 3 insertions, 4 deletions
diff --git a/engines/game.cpp b/engines/game.cpp
index c6d9905b52..c3a7454141 100644
--- a/engines/game.cpp
+++ b/engines/game.cpp
@@ -69,9 +69,6 @@ void GameDescriptor::appendGUIOptions(const Common::String &str) {
}
void GameDescriptor::updateDesc(const char *extra) {
- // TODO: The format used here (LANG/PLATFORM/EXTRA) is not set in stone.
- // We may want to change the order (PLATFORM/EXTRA/LANG, anybody?), or
- // the seperator (instead of '/' use ', ' or ' ').
const bool hasCustomLanguage = (language() != Common::UNK_LANG);
const bool hasCustomPlatform = (platform() != Common::kPlatformUnknown);
const bool hasExtraDesc = (extra && extra[0]);
diff --git a/engines/game.h b/engines/game.h
index 3216cfb628..1cf2c4b39d 100644
--- a/engines/game.h
+++ b/engines/game.h
@@ -64,7 +64,9 @@ public:
uint32 guioptions = 0);
/**
- * Update the description string by appending (LANG/PLATFORM/EXTRA) to it.
+ * Update the description string by appending (EXTRA/PLATFORM/LANG) to it.
+ * Values that are missing are omitted, so e.g. (EXTRA/LANG) would be
+ * added if no platform has been specified but a language and an extra string.
*/
void updateDesc(const char *extra = 0);