summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Firebaugh <john.firebaugh@gmail.com>2016-02-23 14:19:31 -0800
committerJohn Firebaugh <john.firebaugh@gmail.com>2016-02-24 13:38:14 -0800
commit5a6cee0dd0f90f8a3bfa79ebde2a4896b9eeaeea (patch)
treef891053c7f0e0c09ca116f2010ea841f6513eb98
parentd8c066ce0aab51b74eb7b2e7c0fbe2a11e78ac6a (diff)
downloadqtlocation-mapboxgl-5a6cee0dd0f90f8a3bfa79ebde2a4896b9eeaeea.tar.gz
[core] Add a descriptive comment about maximumCacheSize
-rw-r--r--include/mbgl/storage/default_file_source.hpp7
1 files changed, 7 insertions, 0 deletions
diff --git a/include/mbgl/storage/default_file_source.hpp b/include/mbgl/storage/default_file_source.hpp
index d55e12b778..3e839bbc18 100644
--- a/include/mbgl/storage/default_file_source.hpp
+++ b/include/mbgl/storage/default_file_source.hpp
@@ -15,6 +15,13 @@ template <typename T> class Thread;
class DefaultFileSource : public FileSource {
public:
+ /*
+ * The maximumCacheSize parameter is a limit applied to non-offline resources only,
+ * i.e. resources added to the database for the "ambient use" caching functionality.
+ * There is no size limit for offline resources. If a user never creates any offline
+ * regions, we want the database to remain fairly small (order tens or low hundreds
+ * of megabytes).
+ */
DefaultFileSource(const std::string& cachePath,
const std::string& assetRoot,
uint64_t maximumCacheSize = util::DEFAULT_MAX_CACHE_SIZE);