aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVamsidhar reddy Gaddam <gvamsi@google.com>2023-01-03 16:16:38 +0000
committerVamsidhar reddy Gaddam <gvamsi@google.com>2023-01-03 16:16:38 +0000
commitaebf66a400f19caa0a1da3c92696fbc4faeb83f6 (patch)
tree8ee7de22cacb1883d58f02590abb9bac48b458de
parent671ed6a0dd71f5fde78fda86c873b8f830b82056 (diff)
downloadgamesdk-aebf66a400f19caa0a1da3c92696fbc4faeb83f6.tar.gz
Fix comments in tuningfork API
Bug: b/256084775 Test: N/A Change-Id: Ie5a32dac5e020bbdb7e5a49c91fb891ecf435e6e
-rw-r--r--include/tuningfork/tuningfork.h6
1 files changed, 2 insertions, 4 deletions
diff --git a/include/tuningfork/tuningfork.h b/include/tuningfork/tuningfork.h
index 1395c411..15398810 100644
--- a/include/tuningfork/tuningfork.h
+++ b/include/tuningfork/tuningfork.h
@@ -414,10 +414,6 @@ inline void TuningFork_CProtobufSerialization_free(
TuningFork_ErrorCode TuningFork_init(const TuningFork_Settings* settings,
JNIEnv* env, jobject context);
-// The functions below will return TUNINGFORK_ERROR_TUNINGFORK_NOT_INITIALIZED
-// if TuningFork_init
-// has not first been called.
-
/**
* @brief A blocking call to get fidelity parameters from the server.
* You do not need to call this if you pass in a fidelity_params_callback as
@@ -437,6 +433,8 @@ TuningFork_ErrorCode TuningFork_init(const TuningFork_Settings* settings,
* Settings.initial_request_timeout_ms is used.
* @return TUNINGFORK_ERROR_TIMEOUT if there was a timeout before params could
* be downloaded.
+ * @return TUNINGFORK_ERROR_TUNINGFORK_NOT_INITIALIZED if TuningFork_init has
+ * not been called.
* @return TUNINGFORK_ERROR_OK on success.
*/
TuningFork_ErrorCode TuningFork_getFidelityParameters(