From 94fe07a4da175640339b51f8042e6eb2ed8675e3 Mon Sep 17 00:00:00 2001 From: Dave Borowitz Date: Fri, 28 Apr 2017 12:32:26 -0400 Subject: [PATCH] Clarify arguments to EmailReviewComments.Factory Change-Id: I6c280739d24e23c7af45954c14e73036ae9020f7 --- .../server/change/EmailReviewComments.java | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/change/EmailReviewComments.java b/gerrit-server/src/main/java/com/google/gerrit/server/change/EmailReviewComments.java index 2e8fc2d0e2..8e3ee9f90a 100644 --- a/gerrit-server/src/main/java/com/google/gerrit/server/change/EmailReviewComments.java +++ b/gerrit-server/src/main/java/com/google/gerrit/server/change/EmailReviewComments.java @@ -50,6 +50,24 @@ public class EmailReviewComments implements Runnable, RequestContext { private static final Logger log = LoggerFactory.getLogger(EmailReviewComments.class); public interface Factory { + // TODO(dborowitz/wyatta): Rationalize these arguments so HTML and text templates are operating + // on the same set of inputs. + /** + * @param notify setting for handling notification. + * @param accountsToNotify detailed map of accounts to notify. + * @param notes change notes. + * @param patchSet patch set corresponding to the top-level op + * @param user user the email should come from. + * @param message used by text template only: the full ChangeMessage that will go in the + * database. The contents of this message typically include the "Patch set N" header and "(M + * comments)". + * @param comments inline comments. + * @param patchSetComment used by HTML template only: some quasi-human-generated text. The + * contents should *not* include a "Patch set N" header or "(M comments)" footer, as these + * will be added automatically in soy in a structured way. + * @param labels labels applied as part of this review operation. + * @return handle for sending email. + */ EmailReviewComments create( NotifyHandling notify, ListMultimap accountsToNotify,