summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author TreeHugger Robot <treehugger-gerrit@google.com> 2017-06-20 17:37:16 +0000
committer Android (Google) Code Review <android-gerrit@google.com> 2017-06-20 17:37:22 +0000
commit101ba665ddcd40de9f2fe51be910f03b90574a55 (patch)
tree58923cb47cd4ef75a93ac803c877e6d863465f7b
parent2542fe70b55e5f0236efcccb89aead44155ca512 (diff)
parent26b21c4f6b350ea6dba1ffc89c9586842cc3c040 (diff)
Merge "Document what ALL_PAGES returning from onWrite means"
-rw-r--r--core/java/android/print/PrintDocumentAdapter.java4
1 files changed, 3 insertions, 1 deletions
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 */