use a .summary file

[fanfix.git] / src / be / nikiroo / fanfix / supported / BasicSupportPara.java

diff --git a/src/be/nikiroo/fanfix/supported/BasicSupportPara.java b/src/be/nikiroo/fanfix/supported/BasicSupportPara.java
index 1dbedc9cc326b0bdcb18e11753c8d78ccc611e22..e550d82ee0257ffb84bd8a9aee0eddf044d3c55e 100644 (file)
--- 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)