X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2Fresources%2FMeta.java;h=fb4d4915015e2c1efbf4021c8dd7ef4d2623c98e;hb=601003e69e1dc81774243c6eadf7982b6b563b33;hp=f316df4f63b0a4fa53292fae879834da95ad6eeb;hpb=0877d6f5485d3531b9fde6c264e5848630c80baf;p=fanfix.git diff --git a/src/be/nikiroo/utils/resources/Meta.java b/src/be/nikiroo/utils/resources/Meta.java index f316df4..fb4d491 100644 --- a/src/be/nikiroo/utils/resources/Meta.java +++ b/src/be/nikiroo/utils/resources/Meta.java @@ -50,12 +50,26 @@ public @interface Meta { } /** - * A description of this item (what it is or does, how to explain that item - * to the user). + * A description for this item: what it is or does, how to explain that item + * to the user including what can be used here (i.e., %s = file name, %d = + * file size...). + *

+ * For group, the first line ('\\n'-separated) will be used as a title while + * the rest will be the description. * * @return what it is */ String description() default ""; + + /** + * This item should be hidden from the user (she will still be able to + * modify it if she opens the file manually). + *

+ * Defaults to FALSE (visible). + * + * @return TRUE if it should stay hidden + */ + boolean hidden() default false; /** * This item is only used as a group, not as an option. @@ -110,13 +124,9 @@ public @interface Meta { boolean array() default false; /** - * An addition to the format. - *

- * Free info text to help translate, for instance the parameters order and - * type for String translations (i.e., %s = input file name, %d = file size - * in MB). - * - * @return some info + * @deprecated add the info into the description, as only the description + * will be translated. */ + @Deprecated String info() default ""; }