am 14d985bd: am 0f6807bf: Merge "[HW7] Introduce consumed events" into lmp-dev

* commit '14d985bdbdfd4a237add1009912a6920573c1a9d':
  [HW7] Introduce consumed events

1 files changed, 2 insertions, 0 deletions

diff --git a/java/src/com/android/inputmethod/event/CombinerChain.java b/java/src/com/android/inputmethod/event/CombinerChain.java
index 8c6b3d949..8ddc9e7d9 100644
--- a/java/src/com/android/inputmethod/event/CombinerChain.java
+++ b/java/src/com/android/inputmethod/event/CombinerChain.java
@@ -84,6 +84,8 @@ public class CombinerChain {
      * Process an event through the combining chain, and return a processed event to apply.
      * @param previousEvents the list of previous events in this composition
      * @param newEvent the new event to process
+     * @return the processed event. It may be the same event, or a consumed event, or a completely
+     *   new event. However it may never be null.
      */
     public Event processEvent(final ArrayList<Event> previousEvents, final Event newEvent) {
         final ArrayList<Event> modifiablePreviousEvents = new ArrayList<>(previousEvents);