From: James Moger <james.moger@gitblit.com>
Date: Sun, 13 Apr 2014 15:52:26 +0000 (-0400)
Subject: Documentation
X-Git-Tag: v1.5.0~59
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=a3ac802e4cd624129131b8004852d608ac2cf64c;p=gitblit.git

Documentation
---

diff --git a/src/main/java/com/gitblit/extensions/PatchsetHook.java b/src/main/java/com/gitblit/extensions/PatchsetHook.java
index e465f507..fa48aae0 100644
--- a/src/main/java/com/gitblit/extensions/PatchsetHook.java
+++ b/src/main/java/com/gitblit/extensions/PatchsetHook.java
@@ -23,6 +23,7 @@ import com.gitblit.models.TicketModel;
  * Extension point for plugins to respond to Ticket patchset changes.
  *
  * @author James Moger
+ * @since 1.5.0
  *
  */
 public abstract class PatchsetHook implements ExtensionPoint {
@@ -33,6 +34,7 @@ public abstract class PatchsetHook implements ExtensionPoint {
 	 * proposal or it may be a existing ticket that now has a new patchset.
 	 *
 	 * @param ticket
+	 * @since 1.5.0
 	 */
 	public abstract void onNewPatchset(TicketModel ticket);
 
@@ -40,6 +42,7 @@ public abstract class PatchsetHook implements ExtensionPoint {
 	 * Called after a patchset has been FAST-FORWARD updated.
 	 *
 	 * @param ticket
+	 * @since 1.5.0
 	 */
 	public abstract void onUpdatePatchset(TicketModel ticket);
 
@@ -48,6 +51,7 @@ public abstract class PatchsetHook implements ExtensionPoint {
 	 * in the ticket.
 	 *
 	 * @param ticket
+	 * @since 1.5.0
 	 */
 	public abstract void onMergePatchset(TicketModel ticket);
 }
diff --git a/src/main/java/com/gitblit/extensions/ReceiveHook.java b/src/main/java/com/gitblit/extensions/ReceiveHook.java
index 00dcb3e3..b3c9d9fd 100644
--- a/src/main/java/com/gitblit/extensions/ReceiveHook.java
+++ b/src/main/java/com/gitblit/extensions/ReceiveHook.java
@@ -27,7 +27,7 @@ import com.gitblit.git.GitblitReceivePack;
  * Extension point for plugins to process commits on Pre- and Post- Receive.
  *
  * @author James Moger
- *
+ * @since 1.5.0
  */
 public abstract class ReceiveHook implements ExtensionPoint {
 
@@ -38,6 +38,7 @@ public abstract class ReceiveHook implements ExtensionPoint {
 	 *
 	 * @param receivePack
 	 * @param commands
+	 * @since 1.5.0
 	 */
 	public abstract void onPreReceive(GitblitReceivePack receivePack, Collection<ReceiveCommand> commands);
 
@@ -48,6 +49,7 @@ public abstract class ReceiveHook implements ExtensionPoint {
 	 *
 	 * @param receivePack
 	 * @param commands
+	 * @since 1.5.0
 	 */
 	public abstract void onPostReceive(GitblitReceivePack receivePack, Collection<ReceiveCommand> commands);
 }
diff --git a/src/main/java/com/gitblit/extensions/TicketHook.java b/src/main/java/com/gitblit/extensions/TicketHook.java
index 3acbef30..c6e548d0 100644
--- a/src/main/java/com/gitblit/extensions/TicketHook.java
+++ b/src/main/java/com/gitblit/extensions/TicketHook.java
@@ -24,7 +24,7 @@ import com.gitblit.models.TicketModel.Change;
  * Extension point for plugins to respond to Ticket changes.
  *
  * @author James Moger
- *
+ * @since 1.5.0
  */
 public abstract class TicketHook implements ExtensionPoint {
 
@@ -32,6 +32,7 @@ public abstract class TicketHook implements ExtensionPoint {
 	 * Called when a new ticket is created.
 	 *
 	 * @param ticket
+	 * @since 1.5.0
 	 */
 	public abstract void onNewTicket(TicketModel ticket);
 
@@ -41,6 +42,7 @@ public abstract class TicketHook implements ExtensionPoint {
 	 *
 	 * @param ticket
 	 * @param change
+	 * @since 1.5.0
 	 */
 	public abstract void onUpdateTicket(TicketModel ticket, Change change);
 }
diff --git a/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java b/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
index f8239b55..754a64f3 100644
--- a/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
+++ b/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
@@ -40,6 +40,12 @@ import com.google.common.base.Joiner;
 import com.google.common.base.Strings;
 import com.google.common.collect.Maps;
 
+/**
+ * Parses an SSH command-line and dispatches the command to the appropriate
+ * BaseCommand instance.
+ *
+ * @since 1.5.0
+ */
 public abstract class DispatchCommand extends BaseCommand implements ExtensionPoint {
 
 	private Logger log = LoggerFactory.getLogger(getClass());
@@ -89,6 +95,7 @@ public abstract class DispatchCommand extends BaseCommand implements ExtensionPo
 	 * registered within this method.
 	 *
 	 * @param user
+	 * @since 1.5.0
 	 */
 	protected abstract void setup(UserModel user);
 
diff --git a/src/site/plugins_overview.mkd b/src/site/plugins_overview.mkd
index 29fc8aa8..5cb60d07 100644
--- a/src/site/plugins_overview.mkd
+++ b/src/site/plugins_overview.mkd
@@ -20,7 +20,7 @@ The zip plugins are stored in `${baseFolder}/plugins` and are unpacked on startu
 A plugin defines it's metadata in the META-INF/MANIFEST.MF file:
 
     Plugin-Id: powertools
-    Plugin-Description: Gitblit Powertools
+    Plugin-Description: Command and control Gitblit over SSH
     Plugin-Class: com.gitblit.plugin.powertools.Powertools
     Plugin-Version: 1.2.0
     Plugin-Provider: gitblit.com