From d9f68798555e5ba8b4f7ddecf4a8cabbe9bb161a Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Fri, 01 Jul 2011 21:17:28 -0400
Subject: [PATCH] Documentation. Added JavaDoc comments.
---
src/com/gitblit/models/GitNote.java | 12 ++++++++++--
1 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/src/com/gitblit/models/GitNote.java b/src/com/gitblit/models/GitNote.java
index 3b66d89..c333a88 100644
--- a/src/com/gitblit/models/GitNote.java
+++ b/src/com/gitblit/models/GitNote.java
@@ -17,12 +17,20 @@
import java.io.Serializable;
+/**
+ * GitNote is a serializable model class that represents a git note. This class
+ * retains an instance of the RefModel which contains the commit in which this
+ * git note was created.
+ *
+ * @author James Moger
+ *
+ */
public class GitNote implements Serializable {
private static final long serialVersionUID = 1L;
- public String content;
- public RefModel notesRef;
+ public final String content;
+ public final RefModel notesRef;
public GitNote(RefModel notesRef, String text) {
this.notesRef = notesRef;
--
Gitblit v1.9.1