From 26b21c4f6b350ea6dba1ffc89c9586842cc3c040 Mon Sep 17 00:00:00 2001
From: "Philip P. Moltmann" <moltmann@google.com>
Date: Fri, 16 Jun 2017 15:13:17 -0700
Subject: Document what ALL_PAGES returning from onWrite means

Bug: 37802299
Test: Doc only change
Change-Id: I816e22b11951f9800eac988a5d86d96b9afa8912
---
 core/java/android/print/PrintDocumentAdapter.java | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/core/java/android/print/PrintDocumentAdapter.java b/core/java/android/print/PrintDocumentAdapter.java
index 1f59bef853a3..2bb7c2e5f1c3 100644
--- a/core/java/android/print/PrintDocumentAdapter.java
+++ b/core/java/android/print/PrintDocumentAdapter.java
@@ -268,7 +268,9 @@ public abstract class PrintDocumentAdapter {
          * Notifies that all the data was written.
          *
          * @param pages The pages that were written. Cannot be <code>null</code>
-         * or empty.
+         *        or empty. <br />
+         *        Returning {@link PageRange#ALL_PAGES} indicates that all pages that were
+         *        requested as the {@code pages} parameter in {@link #onWrite} were written.
          */
         public void onWriteFinished(PageRange[] pages) {
             /* do nothing - stub */
-- 
cgit v1.2.3-59-g8ed1b