Convert /** @param */ to {@param} in Soy.

This is a patch from what've been converted internally. Change-Id: I19e50e65e7df90393c60c2a7f89edfafc79a5e02
2019-03-04 14:10:20 +01:00
parent c0efebb4fd
commit e951478c60
29 changed files with 98 additions and 127 deletions
--- a/resources/com/google/gerrit/server/mail/Abandoned.soy
+++ b/resources/com/google/gerrit/server/mail/Abandoned.soy
@@ -19,12 +19,12 @@
 /**
 * .Abandoned template will determine the contents of the email related to a
 * change being abandoned.
- * @param change
- * @param coverLetter
- * @param email
- * @param fromName
 */
 {template .Abandoned kind="text"}
+  {@param change: ?}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  {@param fromName: ?}
  {$fromName} has abandoned this change.
  {if $email.changeUrl} ( {$email.changeUrl} ){/if}{\n}
  {\n}
--- a/resources/com/google/gerrit/server/mail/AbandonedHtml.soy
+++ b/resources/com/google/gerrit/server/mail/AbandonedHtml.soy
@@ -16,12 +16,10 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param coverLetter
- * @param email
- * @param fromName
- */
 {template .AbandonedHtml}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  {@param fromName: ?}
  <p>
    {$fromName} <strong>abandoned</strong> this change.
  </p>
--- a/resources/com/google/gerrit/server/mail/AddKey.soy
+++ b/resources/com/google/gerrit/server/mail/AddKey.soy
@@ -19,9 +19,9 @@
 /**
 * The .AddKey template will determine the contents of the email related to
 * adding a new SSH or GPG key to an account.
- * @param email
 */
 {template .AddKey kind="text"}
+  {@param email: ?}
  One or more new {$email.keyType} keys have been added to Gerrit Code Review at
  {sp}{$email.gerritHost}:

--- a/resources/com/google/gerrit/server/mail/AddKeyHtml.soy
+++ b/resources/com/google/gerrit/server/mail/AddKeyHtml.soy
@@ -16,10 +16,8 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param email
- */
 {template .AddKeyHtml}
+  {@param email: ?}
  <p>
    One or more new {$email.keyType} keys have been added to Gerrit Code Review
    at {$email.gerritHost}:
--- a/resources/com/google/gerrit/server/mail/ChangeFooter.soy
+++ b/resources/com/google/gerrit/server/mail/ChangeFooter.soy
@@ -19,9 +19,9 @@
 /**
 * The .ChangeFooter template will determine the contents of the footer text
 * that will be appended to ALL emails related to changes.
- * @param email
 */
 {template .ChangeFooter kind="text"}
+  {@param email: ?}
  --{sp}
  {\n}

--- a/resources/com/google/gerrit/server/mail/ChangeFooterHtml.soy
+++ b/resources/com/google/gerrit/server/mail/ChangeFooterHtml.soy
@@ -16,11 +16,9 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param change
- * @param email
- */
 {template .ChangeFooterHtml}
+  {@param change: ?}
+  {@param email: ?}
  {if $email.changeUrl or $email.settingsUrl}
    <p>
      {if $email.changeUrl}
--- a/resources/com/google/gerrit/server/mail/ChangeSubject.soy
+++ b/resources/com/google/gerrit/server/mail/ChangeSubject.soy
@@ -19,13 +19,13 @@
 /**
 * The .ChangeSubject template will determine the contents of the email subject
 * line for ALL emails related to changes.
- * @param branch
- * @param change
- * @param shortProjectName
- * @param instanceAndProjectName
- * @param addInstanceNameInSubject boolean
 */
 {template .ChangeSubject kind="text"}
+  {@param branch: ?}
+  {@param change: ?}
+  {@param shortProjectName: ?}
+  {@param instanceAndProjectName: ?}
+  {@param addInstanceNameInSubject: ?}  /** boolean */
  {if not $addInstanceNameInSubject}
    Change in {$shortProjectName}[{$branch.shortName}]: {$change.shortSubject}
  {else}
--- a/resources/com/google/gerrit/server/mail/Comment.soy
+++ b/resources/com/google/gerrit/server/mail/Comment.soy
@@ -19,13 +19,13 @@
 /**
 * The .Comment template will determine the contents of the email related to a
 * user submitting comments on changes.
- * @param change
- * @param coverLetter
- * @param email
- * @param fromName
- * @param commentFiles
 */
 {template .Comment kind="text"}
+  {@param change: ?}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  {@param fromName: ?}
+  {@param commentFiles: ?}
  {$fromName} has posted comments on this change.
  {if $email.changeUrl} ( {$email.changeUrl} ){/if}{\n}
  {\n}
--- a/resources/com/google/gerrit/server/mail/CommentHtml.soy
+++ b/resources/com/google/gerrit/server/mail/CommentHtml.soy
@@ -16,15 +16,13 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param commentFiles
- * @param commentCount
- * @param email
- * @param labels
- * @param patchSet
- * @param patchSetCommentBlocks
- */
 {template .CommentHtml}
+  {@param commentFiles: ?}
+  {@param commentCount: ?}
+  {@param email: ?}
+  {@param labels: ?}
+  {@param patchSet: ?}
+  {@param patchSetCommentBlocks: ?}
  {let $commentHeaderStyle kind="css"}
    margin-bottom: 4px;
  {/let}
--- a/resources/com/google/gerrit/server/mail/DeleteReviewer.soy
+++ b/resources/com/google/gerrit/server/mail/DeleteReviewer.soy
@@ -19,12 +19,12 @@
 /**
 * The .DeleteReviewer template will determine the contents of the email related
 * to removal of a reviewer (and the reviewer's votes) from reviews.
- * @param change
- * @param coverLetter
- * @param email
- * @param fromName
 */
 {template .DeleteReviewer kind="text"}
+  {@param change: ?}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  {@param fromName: ?}
  {$fromName} has removed{sp}
  {for $reviewerName in $email.reviewerNames}
    {if not isFirst($reviewerName)},{sp}{/if}
--- a/resources/com/google/gerrit/server/mail/DeleteReviewerHtml.soy
+++ b/resources/com/google/gerrit/server/mail/DeleteReviewerHtml.soy
@@ -16,11 +16,9 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param email
- * @param fromName
- */
 {template .DeleteReviewerHtml}
+  {@param email: ?}
+  {@param fromName: ?}
  <p>
    {$fromName}{sp}
    <strong>
--- a/resources/com/google/gerrit/server/mail/DeleteVote.soy
+++ b/resources/com/google/gerrit/server/mail/DeleteVote.soy
@@ -19,11 +19,11 @@
 /**
 * The .DeleteVote template will determine the contents of the email related
 * to removing votes on changes.
- * @param change
- * @param coverLetter
- * @param fromName
 */
 {template .DeleteVote kind="text"}
+  {@param change: ?}
+  {@param coverLetter: ?}
+  {@param fromName: ?}
  {$fromName} has removed a vote on this change.{\n}
  {\n}
  Change subject: {$change.subject}{\n}
--- a/resources/com/google/gerrit/server/mail/DeleteVoteHtml.soy
+++ b/resources/com/google/gerrit/server/mail/DeleteVoteHtml.soy
@@ -16,12 +16,10 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param coverLetter
- * @param email
- * @param fromName
- */
 {template .DeleteVoteHtml}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  {@param fromName: ?}
  <p>
    {$fromName} <strong>removed a vote</strong> from this change.
  </p>
--- a/resources/com/google/gerrit/server/mail/Footer.soy
+++ b/resources/com/google/gerrit/server/mail/Footer.soy
@@ -20,9 +20,9 @@
 * The .Footer template will determine the contents of the footer text
 * appended to the end of all outgoing emails after the ChangeFooter and
 * CommentFooter.
- * @param footers
 */
 {template .Footer kind="text"}
+  {@param footers: ?}
  {for $footer in $footers}
    {$footer}{\n}
  {/for}
--- a/resources/com/google/gerrit/server/mail/FooterHtml.soy
+++ b/resources/com/google/gerrit/server/mail/FooterHtml.soy
@@ -16,10 +16,8 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param footers
- */
 {template .FooterHtml}
+  {@param footers: ?}
  {\n}
  {\n}
  {for $footer in $footers}
--- a/resources/com/google/gerrit/server/mail/Merged.soy
+++ b/resources/com/google/gerrit/server/mail/Merged.soy
@@ -20,11 +20,11 @@
 /**
 * The .Merged template will determine the contents of the email related to
 * a change successfully merged to the head.
- * @param change
- * @param email
- * @param fromName
 */
 {template .Merged kind="text"}
+  {@param change: ?}
+  {@param email: ?}
+  {@param fromName: ?}
  {$fromName} has submitted this change and it was merged.
  {if $email.changeUrl} ( {$email.changeUrl} ){/if}{\n}
  {\n}
--- a/resources/com/google/gerrit/server/mail/MergedHtml.soy
+++ b/resources/com/google/gerrit/server/mail/MergedHtml.soy
@@ -16,12 +16,10 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param diffLines
- * @param email
- * @param fromName
- */
 {template .MergedHtml}
+  {@param diffLines: ?}
+  {@param email: ?}
+  {@param fromName: ?}
  <p>
    {$fromName} <strong>merged</strong> this change.
  </p>
--- a/resources/com/google/gerrit/server/mail/NewChange.soy
+++ b/resources/com/google/gerrit/server/mail/NewChange.soy
@@ -19,13 +19,13 @@
 /**
 * The .NewChange template will determine the contents of the email related to a
 * user submitting a new change for review.
- * @param change
- * @param email
- * @param ownerName
- * @param patchSet
- * @param projectName
 */
 {template .NewChange kind="text"}
+  {@param change: ?}
+  {@param email: ?}
+  {@param ownerName: ?}
+  {@param patchSet: ?}
+  {@param projectName: ?}
  {if $email.reviewerNames}
    Hello{sp}
    {for $reviewerName in $email.reviewerNames}
--- a/resources/com/google/gerrit/server/mail/NewChangeHtml.soy
+++ b/resources/com/google/gerrit/server/mail/NewChangeHtml.soy
@@ -16,15 +16,13 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param diffLines
- * @param email
- * @param fromName
- * @param ownerName
- * @param patchSet
- * @param projectName
- */
 {template .NewChangeHtml}
+  {@param diffLines: ?}
+  {@param email: ?}
+  {@param fromName: ?}
+  {@param ownerName: ?}
+  {@param patchSet: ?}
+  {@param projectName: ?}
  <p>
    {if $email.reviewerNames}
      {$fromName} would like{sp}
--- a/resources/com/google/gerrit/server/mail/Private.soy
+++ b/resources/com/google/gerrit/server/mail/Private.soy
@@ -22,17 +22,17 @@

 /**
 * Private template to generate "View Change" buttons.
- * @param email
 */
 {template .ViewChangeButton}
+  {@param email: ?}
  <a href="{$email.changeUrl}">View Change</a>
 {/template}

 /**
 * Private template to render PRE block with consistent font-sizing.
- * @param content
 */
 {template .Pre}
+  {@param content: ?}
  {let $preStyle kind="css"}
    font-family: monospace,monospace; // Use this to avoid browsers scaling down
                                      // monospace text.
@@ -53,10 +53,9 @@
 *
 * This mechanism encodes as little structure as possible in order to depend on
 * the Soy autoescape mechanism for all of the content.
- *
- * @param content
 */
 {template .WikiFormat}
+  {@param content: ?}
  {let $blockquoteStyle kind="css"}
    border-left: 1px solid #aaa;
    margin: 10px 0;
@@ -87,10 +86,8 @@
  {/for}
 {/template}

-/**
- * @param diffLines
- */
 {template .UnifiedDiff}
+  {@param diffLines: ?}
  {let $addStyle kind="css"}
    color: hsl(120, 100%, 40%);
  {/let}
--- a/resources/com/google/gerrit/server/mail/RegisterNewEmail.soy
+++ b/resources/com/google/gerrit/server/mail/RegisterNewEmail.soy
@@ -19,9 +19,9 @@
 /**
 * The .RegisterNewEmail template will determine the contents of the email
 * related to registering new email accounts.
- * @param email
 */
 {template .RegisterNewEmail kind="text"}
+  {@param email: ?}
  Welcome to Gerrit Code Review at {$email.gerritHost}.{\n}

  {\n}
--- a/resources/com/google/gerrit/server/mail/ReplacePatchSet.soy
+++ b/resources/com/google/gerrit/server/mail/ReplacePatchSet.soy
@@ -19,14 +19,14 @@
 /**
 * The .ReplacePatchSet template will determine the contents of the email
 * related to a user submitting a new patchset for a change.
- * @param change
- * @param email
- * @param fromEmail
- * @param fromName
- * @param patchSet
- * @param projectName
 */
 {template .ReplacePatchSet kind="text"}
+  {@param change: ?}
+  {@param email: ?}
+  {@param fromEmail: ?}
+  {@param fromName: ?}
+  {@param patchSet: ?}
+  {@param projectName: ?}
  {if $email.reviewerNames and $fromEmail == $change.ownerEmail}
    Hello{sp}
    {for $reviewerName in $email.reviewerNames}
--- a/resources/com/google/gerrit/server/mail/ReplacePatchSetHtml.soy
+++ b/resources/com/google/gerrit/server/mail/ReplacePatchSetHtml.soy
@@ -16,15 +16,13 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param change
- * @param email
- * @param fromName
- * @param fromEmail
- * @param patchSet
- * @param projectName
- */
 {template .ReplacePatchSetHtml}
+  {@param change: ?}
+  {@param email: ?}
+  {@param fromName: ?}
+  {@param fromEmail: ?}
+  {@param patchSet: ?}
+  {@param projectName: ?}
  <p>
    {$fromName} <strong>uploaded patch set #{$patchSet.patchSetId}</strong>{sp}
    to{sp}
--- a/resources/com/google/gerrit/server/mail/Restored.soy
+++ b/resources/com/google/gerrit/server/mail/Restored.soy
@@ -19,12 +19,12 @@
 /**
 * The .Restored template will determine the contents of the email related to a
 * change being restored.
- * @param change
- * @param coverLetter
- * @param email
- * @param fromName
 */
 {template .Restored kind="text"}
+  {@param change: ?}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  {@param fromName: ?}
  {$fromName} has restored this change.
  {if $email.changeUrl} ( {$email.changeUrl} ){/if}{\n}
  {\n}
--- a/resources/com/google/gerrit/server/mail/RestoredHtml.soy
+++ b/resources/com/google/gerrit/server/mail/RestoredHtml.soy
@@ -16,11 +16,9 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param email
- * @param fromName
- */
 {template .RestoredHtml}
+  {@param email: ?}
+  {@param fromName: ?}
  <p>
    {$fromName} <strong>restored</strong> this change.
  </p>
--- a/resources/com/google/gerrit/server/mail/Reverted.soy
+++ b/resources/com/google/gerrit/server/mail/Reverted.soy
@@ -19,12 +19,12 @@
 /**
 * The .Reverted template will determine the contents of the email related
 * to a change being reverted.
- * @param change
- * @param coverLetter
- * @param email
- * @param fromName
 */
 {template .Reverted kind="text"}
+  {@param change: ?}
+  {@param coverLetter: ?}
+  {@param email: ?}
+  {@param fromName: ?}
  {$fromName} has created a revert of this change.
  {if $email.changeUrl} ( {$email.changeUrl} ){/if}{\n}
  {\n}
--- a/resources/com/google/gerrit/server/mail/RevertedHtml.soy
+++ b/resources/com/google/gerrit/server/mail/RevertedHtml.soy
@@ -16,11 +16,9 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param email
- * @param fromName
- */
 {template .RevertedHtml}
+  {@param email: ?}
+  {@param fromName: ?}
  <p>
    {$fromName} has <strong>created a revert</strong> of this change.
  </p>
--- a/resources/com/google/gerrit/server/mail/SetAssignee.soy
+++ b/resources/com/google/gerrit/server/mail/SetAssignee.soy
@@ -19,13 +19,13 @@
 /**
 * The .SetAssignee template will determine the contents of the email related
 * to a user being assigned to a change.
- * @param change
- * @param email
- * @param fromName
- * @param patchSet
- * @param projectName
 */
 {template .SetAssignee kind="text"}
+  {@param change: ?}
+  {@param email: ?}
+  {@param fromName: ?}
+  {@param patchSet: ?}
+  {@param projectName: ?}
  Hello{sp}
  {$email.assigneeName},

--- a/resources/com/google/gerrit/server/mail/SetAssigneeHtml.soy
+++ b/resources/com/google/gerrit/server/mail/SetAssigneeHtml.soy
@@ -16,14 +16,12 @@

 {namespace com.google.gerrit.server.mail.template}

-/**
- * @param diffLines
- * @param email
- * @param fromName
- * @param patchSet
- * @param projectName
- */
 {template .SetAssigneeHtml}
+  {@param diffLines: ?}
+  {@param email: ?}
+  {@param fromName: ?}
+  {@param patchSet: ?}
+  {@param projectName: ?}
  <p>
    {$fromName} has <strong>assigned</strong> a change to{sp}
    {$email.assigneeName}.{sp}