X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Fsupported%2FBasicSupportPara.java;h=e550d82ee0257ffb84bd8a9aee0eddf044d3c55e;hb=34f8780d16faf3a5466c45261bd84f1b31516790;hp=58c363af59b77e1b4f4d1c323fefe2af350ad31b;hpb=4d9e85d00d491422eb436d05b5de5af0cb326cdb;p=nikiroo-utils.git

diff --git a/src/be/nikiroo/fanfix/supported/BasicSupportPara.java b/src/be/nikiroo/fanfix/supported/BasicSupportPara.java
index 58c363a..e550d82 100644
--- a/src/be/nikiroo/fanfix/supported/BasicSupportPara.java
+++ b/src/be/nikiroo/fanfix/supported/BasicSupportPara.java
@@ -35,6 +35,17 @@ public class BasicSupportPara {
 	BasicSupportHelper bsHelper;
 	BasicSupportImages bsImages;
 	
+	/**
+	 * Create a new {@link BasicSupportPara}.
+	 * <p>
+	 * Note that you need an instance of both {@link BasicSupportHelper} and
+	 * {@link BasicSupportImages} for it to work.
+	 * 
+	 * @param bsHelper
+	 *            the required {@link BasicSupportHelper}
+	 * @param bsImages
+	 *            the required {@link BasicSupportImages}
+	 */
 	public BasicSupportPara(BasicSupportHelper bsHelper, BasicSupportImages bsImages) {
 		this.bsHelper = bsHelper;
 		this.bsImages = bsImages;
@@ -45,7 +56,7 @@ public class BasicSupportPara {
 	 * the content as it should be.
 	 * 
 	 * @param support
-	 *            the linked {@link BasicSupport}
+	 *            the linked {@link BasicSupport} (can be NULL)
 	 * @param source
 	 *            the source of the story (for image lookup in the same path if
 	 *            the source is a file, can be NULL)
@@ -60,7 +71,7 @@ public class BasicSupportPara {
 	 * @param html
 	 *            TRUE if the input content is in HTML mode
 	 * 
-	 * @return the {@link Chapter}
+	 * @return the {@link Chapter}, never NULL
 	 * 
 	 * @throws IOException
 	 *             in case of I/O error
@@ -202,7 +213,7 @@ public class BasicSupportPara {
 	 * @param html
 	 *            TRUE if the input content is in HTML mode
 	 * 
-	 * @return the processed {@link Paragraph}
+	 * @return the processed {@link Paragraph}, never NULL
 	 */
 	protected Paragraph processPara(String line, boolean html) {
 		if (html) {
@@ -423,7 +434,7 @@ public class BasicSupportPara {
 	 * @param pg
 	 *            the optional progress reporter
 	 * 
-	 * @return the {@link Paragraph}s
+	 * @return the {@link Paragraph}s (can be empty but never NULL)
 	 * 
 	 * @throws IOException
 	 *             in case of I/O error
@@ -514,7 +525,7 @@ public class BasicSupportPara {
 	 * @param html
 	 *            TRUE if the input content is in HTML mode
 	 * 
-	 * @return the {@link Paragraph}
+	 * @return the {@link Paragraph}, never NULL
 	 */
 	protected Paragraph makeParagraph(BasicSupport support, URL source,
 			String line, boolean html) {