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;
* 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)
* @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
* @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) {
* @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
* @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) {