From 6ca31c61cf02f1c56fcbe9d501a7f147d8bfcc5f Mon Sep 17 00:00:00 2001
From: anthony restaino <anthonyrestaino11@gmail.com>
Date: Sun, 7 May 2017 23:32:41 -0400
Subject: [PATCH] Add documentation for BookmarkUiModel

---
 .../lightning/activity/BookmarkUiModel.java    | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/app/src/main/java/acr/browser/lightning/activity/BookmarkUiModel.java b/app/src/main/java/acr/browser/lightning/activity/BookmarkUiModel.java
index 5895dee..457a984 100644
--- a/app/src/main/java/acr/browser/lightning/activity/BookmarkUiModel.java
+++ b/app/src/main/java/acr/browser/lightning/activity/BookmarkUiModel.java
@@ -14,14 +14,32 @@ public class BookmarkUiModel {
 
     @Nullable private String mCurrentFolder;
 
+    /**
+     * Sets the current folder that is being shown.
+     * Use null as the root folder.
+     *
+     * @param folder the current folder, null for root.
+     */
     public void setCurrentFolder(@Nullable String folder) {
         mCurrentFolder = folder;
     }
 
+    /**
+     * Determines if the current folder is
+     * the root folder.
+     *
+     * @return true if the current folder is
+     * the root, false otherwise.
+     */
     public boolean isRootFolder() {
         return mCurrentFolder == null;
     }
 
+    /**
+     * Gets the current folder that is being shown.
+     *
+     * @return the current folder, null for root.
+     */
     @Nullable
     public String getCurrentFolder() {
         return mCurrentFolder;