aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Schickel2016-02-25 20:24:41 +0100
committerJohannes Schickel2016-02-25 21:39:45 +0100
commitd7bb90ba84615f9e261118abb13d88b316cb92d7 (patch)
treec23b7d94809a8c175331ca2c012201ee138c035c
parentd38a22011e53570629620166653978d32e35f5e8 (diff)
downloadscummvm-rg350-d7bb90ba84615f9e261118abb13d88b316cb92d7.tar.gz
scummvm-rg350-d7bb90ba84615f9e261118abb13d88b316cb92d7.tar.bz2
scummvm-rg350-d7bb90ba84615f9e261118abb13d88b316cb92d7.zip
ENGINES: Document sorting guaranty for MetaEngine::listSaves.
-rw-r--r--engines/metaengine.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/engines/metaengine.h b/engines/metaengine.h
index 41f3ec4cba..3f8f56c1dd 100644
--- a/engines/metaengine.h
+++ b/engines/metaengine.h
@@ -96,6 +96,9 @@ public:
/**
* Return a list of all save states associated with the given target.
*
+ * The list return is guarnateed to be sorted by slot numbers. That means
+ * lower slot numbers are always stored before bigger slot numbers.
+ *
* The caller has to ensure that this (Meta)Engine is responsible
* for the specified target (by using findGame on it respectively
* on the associated gameid from the relevant ConfMan entry, if present).