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/utils/SyndicationUtils.java | 18 ++++++++++++++++++
1 files changed, 18 insertions(+), 0 deletions(-)
diff --git a/src/com/gitblit/utils/SyndicationUtils.java b/src/com/gitblit/utils/SyndicationUtils.java
index 80a1b28..fb40dd5 100644
--- a/src/com/gitblit/utils/SyndicationUtils.java
+++ b/src/com/gitblit/utils/SyndicationUtils.java
@@ -35,8 +35,26 @@
import com.sun.syndication.io.FeedException;
import com.sun.syndication.io.SyndFeedOutput;
+/**
+ * Utility class for RSS feeds.
+ *
+ * @author James Moger
+ *
+ */
public class SyndicationUtils {
+ /**
+ * Outputs an RSS feed of the list of commits to the outputstream.
+ *
+ * @param hostUrl
+ * @param title
+ * @param description
+ * @param repository
+ * @param commits
+ * @param os
+ * @throws IOException
+ * @throws FeedException
+ */
public static void toRSS(String hostUrl, String title, String description, String repository,
List<RevCommit> commits, OutputStream os) throws IOException, FeedException {
--
Gitblit v1.9.1