From: David ‘Bombe’ Roden <bombe@pterodactylus.net>
Date: Sat, 16 Oct 2010 01:42:27 +0000 (+0200)
Subject: Add javadoc comment.
X-Git-Tag: 0.1-RC1~294
X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=b766f47ecf1c68004a5d3b2050f8853e041b157a;p=Sone.git

Add javadoc comment.
---

diff --git a/src/main/java/net/pterodactylus/sone/core/SoneDownloader.java b/src/main/java/net/pterodactylus/sone/core/SoneDownloader.java
index 4d39568..b7871dd 100644
--- a/src/main/java/net/pterodactylus/sone/core/SoneDownloader.java
+++ b/src/main/java/net/pterodactylus/sone/core/SoneDownloader.java
@@ -114,6 +114,15 @@ public class SoneDownloader extends AbstractService {
 		parseSone(sone, fetchResult);
 	}
 
+	/**
+	 * Parses a Sone from a fetch result.
+	 *
+	 * @param sone
+	 *            The sone to parse, or {@code null} if the Sone is yet unknown
+	 * @param fetchResult
+	 *            The fetch result
+	 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
+	 */
 	public Sone parseSone(Sone sone, FetchResult fetchResult) {
 		logger.log(Level.FINEST, "Persing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), sone });
 		/* TODO - impose a size limit? */