Commit 6de794c9 authored by bartfab's avatar bartfab Committed by Commit bot

Fix documentation of CrosSettings::PrepareTrustedValues()

This CL fixes the documentation of CrosSettings::PrepareTrustedValues()
which had gotten out of sync with the method's actual return value.

BUG=None
TEST=None

Review URL: https://codereview.chromium.org/690753002

Cr-Commit-Position: refs/heads/master@{#302086}
parent 79ebf748
......@@ -49,11 +49,19 @@ class CrosSettings : public base::NonThreadSafe {
// Returns setting value for the given |path|.
const base::Value* GetPref(const std::string& path) const;
// Requests all providers to fetch their values from a trusted store, if they
// haven't done so yet. Returns true if the cros settings returned by |this|
// are trusted during the current loop cycle; otherwise returns false, and
// |callback| will be invoked later when trusted values become available.
// PrepareTrustedValues() should be tried again in that case.
// Requests that all providers ensure the values they are serving were read
// from a trusted store:
// * If all providers are serving trusted values, returns TRUSTED. This
// indicates that the cros settings returned by |this| can be trusted during
// the current loop cycle.
// * If at least one provider ran into a permanent failure while trying to
// read values from its trusted store, returns PERMANENTLY_UNTRUSTED. This
// indicates that the cros settings will never become trusted.
// * Otherwise, returns TEMPORARILY_UNTRUSTED. This indicates that at least
// one provider needs to read values from its trusted store first. The
// |callback| will be called back when the read is done.
// PrepareTrustedValues() should be called again at that point to determine
// whether all providers are serving trusted values now.
virtual CrosSettingsProvider::TrustedStatus PrepareTrustedValues(
const base::Closure& callback) const;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment