From bb11d3d93e310c12004ad83dbde6dd1d31d7b796 Mon Sep 17 00:00:00 2001
From: Simon Brandhof <simon.brandhof@gmail.com>
Date: Fri, 3 May 2013 00:13:32 +0200
Subject: [PATCH] Add some comments

---
 .../src/main/java/org/sonar/core/issue/IssueComment.java   | 7 ++++++-
 .../src/main/java/org/sonar/core/issue/IssueUpdater.java   | 3 +++
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/sonar-core/src/main/java/org/sonar/core/issue/IssueComment.java b/sonar-core/src/main/java/org/sonar/core/issue/IssueComment.java
index a63bdd7de15..4dad7564f20 100644
--- a/sonar-core/src/main/java/org/sonar/core/issue/IssueComment.java
+++ b/sonar-core/src/main/java/org/sonar/core/issue/IssueComment.java
@@ -19,6 +19,7 @@
  */
 package org.sonar.core.issue;
 
+import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
 import java.io.Serializable;
 import java.util.Date;
@@ -49,11 +50,15 @@ public class IssueComment implements Serializable {
     return this;
   }
 
+  /**
+   * The user who created the comment. Null if it was automatically generated during project scan.
+   */
+  @CheckForNull
   public String userLogin() {
     return userLogin;
   }
 
-  public IssueComment setUserLogin(String userLogin) {
+  public IssueComment setUserLogin(@Nullable String userLogin) {
     this.userLogin = userLogin;
     return this;
   }
diff --git a/sonar-core/src/main/java/org/sonar/core/issue/IssueUpdater.java b/sonar-core/src/main/java/org/sonar/core/issue/IssueUpdater.java
index ddccda179d8..60c31e673b0 100644
--- a/sonar-core/src/main/java/org/sonar/core/issue/IssueUpdater.java
+++ b/sonar-core/src/main/java/org/sonar/core/issue/IssueUpdater.java
@@ -27,6 +27,9 @@ import org.sonar.api.ServerComponent;
 import javax.annotation.Nullable;
 import java.util.Date;
 
+/**
+ * Updates issue fields and chooses if changes must be kept in history.
+ */
 public class IssueUpdater implements BatchComponent, ServerComponent {
 
   public boolean setSeverity(DefaultIssue issue, String severity, IssueChangeContext context) {
-- 
2.39.5