From 3907b67fc63c30564e47db50f242ccf0a5aa5cbe Mon Sep 17 00:00:00 2001
From: Takatoshi Kondo <redboltz@gmail.com>
Date: Tue, 22 Jun 2021 07:39:09 +0900
Subject: [PATCH] Fix the comment.

---
 lib/unique-message-id-provider.js | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/unique-message-id-provider.js b/lib/unique-message-id-provider.js
index 5d2203f14..6ffd4bde6 100644
--- a/lib/unique-message-id-provider.js
+++ b/lib/unique-message-id-provider.js
@@ -18,7 +18,8 @@ function UniqueMessageIdProvider () {
  * allocate
  *
  * Get the next messageId.
- * @return unsigned int
+ * @return if messageId is fully allocated then return null,
+ *         otherwise return the smallest usable unsigned int messageId.
  */
 UniqueMessageIdProvider.prototype.allocate = function () {
   this.lastId = this.numberAllocator.alloc()