From 0fbb2d19d6282553fdf5b6ad37f078cb1dc8bfe6 Mon Sep 17 00:00:00 2001
From: Alan Woodward <romseygeek@apache.org>
Date: Thu, 30 Aug 2018 10:30:11 +0100
Subject: [PATCH] LUCENE-8471: Javadocs

---
 .../core/src/java/org/apache/lucene/index/DocumentsWriter.java  | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lucene/core/src/java/org/apache/lucene/index/DocumentsWriter.java b/lucene/core/src/java/org/apache/lucene/index/DocumentsWriter.java
index 136bd81bd31..b4483513e23 100644
--- a/lucene/core/src/java/org/apache/lucene/index/DocumentsWriter.java
+++ b/lucene/core/src/java/org/apache/lucene/index/DocumentsWriter.java
@@ -765,6 +765,8 @@ final class DocumentsWriter implements Closeable, Accountable {
 
   /**
    * Returns the number of bytes currently being flushed
+   *
+   * This is a subset of the value returned by {@link #ramBytesUsed()}
    */
   public long getFlushingBytes() {
     return flushControl.getFlushingBytes();