X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2Fresources%2FMeta.java;h=fb4d4915015e2c1efbf4021c8dd7ef4d2623c98e;hb=68232a49b2f63e195dfaf1d907bd20c48cf2b394;hp=a83bcca418df48fca8f51efa6c1cf9b1275c8174;hpb=9e834013f84e8797acf26f5418ae3448044ad097;p=nikiroo-utils.git diff --git a/src/be/nikiroo/utils/resources/Meta.java b/src/be/nikiroo/utils/resources/Meta.java index a83bcca..fb4d491 100644 --- a/src/be/nikiroo/utils/resources/Meta.java +++ b/src/be/nikiroo/utils/resources/Meta.java @@ -47,25 +47,29 @@ public @interface Meta { * option to enter a not accounted for value). */ COMBO_LIST, - /** - * A list of {@link Format#STRING}s. - *

- * The list items are separated by a comma, each surrounded by - * double-quotes, with backslashes and double-quotes escaped by a - * backslash. - *

- * Example: "un", "deux" - */ - LIST_OF_STRINGS, } /** - * 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. @@ -109,19 +113,20 @@ public @interface Meta { /** * This item is a comma-separated list of values instead of a single value. + *

+ * The list items are separated by a comma, each surrounded by + * double-quotes, with backslashes and double-quotes escaped by a backslash. + *

+ * Example: "un", "deux" * * @return TRUE if it is */ 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 ""; }