From b944f496dc306b696f63c98f147c31e437051aaf Mon Sep 17 00:00:00 2001 From: John Knox Date: Wed, 8 Aug 2018 07:00:26 -0700 Subject: [PATCH] Add javadoc to SonarStateUpdateListener Summary: Documentation Reviewed By: danielbuechele Differential Revision: D9215929 fbshipit-source-id: 1c67fc2098aa0734d85524697f196a6b0ae4c721 --- .../com/facebook/sonar/core/SonarStateUpdateListener.java | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/android/src/main/java/com/facebook/sonar/core/SonarStateUpdateListener.java b/android/src/main/java/com/facebook/sonar/core/SonarStateUpdateListener.java index c790fdb6f..3673266a7 100644 --- a/android/src/main/java/com/facebook/sonar/core/SonarStateUpdateListener.java +++ b/android/src/main/java/com/facebook/sonar/core/SonarStateUpdateListener.java @@ -2,6 +2,11 @@ package com.facebook.sonar.core; public interface SonarStateUpdateListener { + /** + * Called when the state of the sonar client changes. + * Typical implementations will subscribe by calling {@link com.facebook.sonar.core.SonarClient#subscribeForUpdates()}, to start receiving update events. + * Calling {@link com.facebook.sonar.core.SonarClient#getState()} will retrieve the updated state. + */ void onUpdate(); }