From f2738c8bc4b2ce47bd2a5acba85dbf56c84ba48c Mon Sep 17 00:00:00 2001
From: akwizgran <michael@briarproject.org>
Date: Fri, 15 Jul 2022 16:07:26 +0100
Subject: [PATCH] Add some javadocs.

---
 .../bramble/mailbox/OwnMailboxDownloadWorker.java         | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/bramble-core/src/main/java/org/briarproject/bramble/mailbox/OwnMailboxDownloadWorker.java b/bramble-core/src/main/java/org/briarproject/bramble/mailbox/OwnMailboxDownloadWorker.java
index f148ac829..48517f9fa 100644
--- a/bramble-core/src/main/java/org/briarproject/bramble/mailbox/OwnMailboxDownloadWorker.java
+++ b/bramble-core/src/main/java/org/briarproject/bramble/mailbox/OwnMailboxDownloadWorker.java
@@ -63,6 +63,10 @@ class OwnMailboxDownloadWorker extends MailboxDownloadWorker {
 		else listNextFolder(new LinkedList<>(folders), new HashMap<>());
 	}
 
+	/**
+	 * Removes the next folder from `queue` and starts a task to list the
+	 * files in the folder and add them to `available`.
+	 */
 	private void listNextFolder(Queue<MailboxFolderId> queue,
 			Map<MailboxFolderId, Queue<MailboxFile>> available) {
 		synchronized (lock) {
@@ -93,6 +97,10 @@ class OwnMailboxDownloadWorker extends MailboxDownloadWorker {
 		}
 	}
 
+	/**
+	 * Visits the given folders in round-robin order to create a queue of up to
+	 * {@link #MAX_ROUND_ROBIN_FILES} to download.
+	 */
 	private void createDownloadQueue(
 			Map<MailboxFolderId, Queue<MailboxFile>> available) {
 		synchronized (lock) {