Bug 1288256 - Post: add comments explaining HomePager specific methods in HomeScreen r=sebastian

MozReview-Commit-ID: 5hgTMzff6zq

--HG--
extra : rebase_source : a89d18e6cf5e06ae7845a8373535b5fda89fbb59

mobile/android/base/java/org/mozilla/gecko/home/HomeScreen.java

@@ -38,12 +38,17 @@ public interface HomeScreen {
 
     void onToolbarFocusChange(boolean hasFocus);
 
+    // The following three methods are HomePager specific. The persistence framework might need
+    // refactoring/generalising at some point, but it isn't entirely clear what other panels
+    // might need so we can leave these as is for now.
     void showPanel(String panelId, Bundle restoreData);
-
     void setOnPanelChangeListener(OnPanelChangeListener listener);
-
     void setPanelStateChangeListener(HomeFragment.PanelStateChangeListener listener);
 
+    /**
+     * Set a banner that may be displayed at the bottom of the HomeScreen. This can be used
+     * e.g. to show snippets.
+     */
     void setBanner(HomeBanner banner);
 
     void load(LoaderManager lm, FragmentManager fm, String panelId, Bundle restoreData, PropertyAnimator animator);