Some jDoc fixes

[fanfix.git] / src / be / nikiroo / fanfix / output / BasicOutput.java

diff --git a/src/be/nikiroo/fanfix/output/BasicOutput.java b/src/be/nikiroo/fanfix/output/BasicOutput.java
index a21ee97e36fba4a33dcf13e15fc890a7eb23fea2..909c8fe9707b6a76a05d6ebdf151193142757b6e 100644 (file)
--- a/src/be/nikiroo/fanfix/output/BasicOutput.java
+++ b/src/be/nikiroo/fanfix/output/BasicOutput.java
@@ -52,15 +52,23 @@ public abstract class BasicOutput {
                /**
                 * A description of this output type.
                 * 
+                * @param longDesc
+                *            TRUE for the long description, FALSE for the short one
+                * 
                 * @return the description
                 */
-               public String getDesc() {
-                       String desc = Instance.getTrans().getStringX(StringId.OUTPUT_DESC,
-                                       this.name());
+               public String getDesc(boolean longDesc) {
+                       StringId id = longDesc ? StringId.OUTPUT_DESC
+                                       : StringId.OUTPUT_DESC_SHORT;
+
+                       String desc = Instance.getTrans().getStringX(id, this.name());
+
+                       if (desc == null) {
+                               desc = Instance.getTrans().getString(id, this);
+                       }
 
                        if (desc == null) {
-                               desc = Instance.getTrans()
-                                               .getString(StringId.OUTPUT_DESC, this);
+                               desc = this.toString();
                        }
 
                        return desc;
@@ -86,7 +94,8 @@ public abstract class BasicOutput {
                }
 
                /**
-                * Call {@link OutputType#valueOf(String.toUpperCase())}.
+                * Call {@link OutputType#valueOf(String)} after conversion to upper
+                * case.
                 * 
                 * @param typeName
                 *            the possible type name
@@ -99,8 +108,9 @@ public abstract class BasicOutput {
                }
 
                /**
-                * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL
-                * for NULL and empty instead of raising an exception.
+                * Call {@link OutputType#valueOf(String)} after conversion to upper
+                * case but return NULL for NULL and empty instead of raising an
+                * exception.
                 * 
                 * @param typeName
                 *            the possible type name
@@ -116,8 +126,9 @@ public abstract class BasicOutput {
                }
 
                /**
-                * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL
-                * in case of error instead of raising an exception.
+                * Call {@link OutputType#valueOf(String)} after conversion to upper
+                * case but return NULL in case of error instead of raising an
+                * exception.
                 * 
                 * @param typeName
                 *            the possible type name
@@ -167,15 +178,19 @@ public abstract class BasicOutput {
                        throws IOException {
                storyPg = pg;
 
-               target = new File(target).getAbsolutePath();
-               File targetDir = new File(target).getParentFile();
-               String targetName = new File(target).getName();
-
-               String ext = getDefaultExtension(false);
-               if (ext != null && !ext.isEmpty()) {
-                       if (targetName.toLowerCase().endsWith(ext)) {
-                               targetName = targetName.substring(0,
-                                               targetName.length() - ext.length());
+               File targetDir = null;
+               String targetName = null;
+               if (target != null) {
+                       target = new File(target).getAbsolutePath();
+                       targetDir = new File(target).getParentFile();
+                       targetName = new File(target).getName();
+
+                       String ext = getDefaultExtension(false);
+                       if (ext != null && !ext.isEmpty()) {
+                               if (targetName.toLowerCase().endsWith(ext)) {
+                                       targetName = targetName.substring(0, targetName.length()
+                                                       - ext.length());
+                               }
                        }
                }
 
@@ -226,9 +241,10 @@ public abstract class BasicOutput {
         * 
         * @param type
         *            the new type
-        * @param infoCover
-        *            TRUE to enable the creation of a .info file and a cover if
-        *            possible
+        * @param writeInfo
+        *            TRUE to enable the creation of a .info file
+        * @param writeCover
+        *            TRUE to enable the creation of a cover if possible
         * 
         * @return this
         */