Clarify that only StramInfoItems are accepted by the builder

This commit is contained in:
TobiGr 2022-02-21 21:50:30 +01:00
parent ee477b25e5
commit d3bc184971

View file

@ -86,7 +86,7 @@ public final class InfoItemDialog {
} }
/** /**
* <p>Builder to generate a {@link InfoItemDialog}.</p> * <p>Builder to generate a {@link InfoItemDialog} for a {@link StreamInfoItem}.</p>
* Use {@link #addEntry(StreamDialogDefaultEntry)} * Use {@link #addEntry(StreamDialogDefaultEntry)}
* and {@link #addAllEntries(StreamDialogDefaultEntry...)} to add options to the dialog. * and {@link #addAllEntries(StreamDialogDefaultEntry...)} to add options to the dialog.
* <br> * <br>
@ -102,7 +102,8 @@ public final class InfoItemDialog {
private final boolean addDefaultEntriesAutomatically; private final boolean addDefaultEntriesAutomatically;
/** /**
* <p>Create a Builder instance that automatically adds the some default entries * <p>Create a {@link Builder builder} instance for a {@link StreamInfoItem}
* that automatically adds the some default entries
* at the top and bottom of the dialog.</p> * at the top and bottom of the dialog.</p>
* The dialog has the following structure: * The dialog has the following structure:
* <pre> * <pre>
@ -142,7 +143,7 @@ public final class InfoItemDialog {
} }
/** /**
* <p>Create an instance of this Builder.</p> * <p>Create an instance of this {@link Builder} for a {@link StreamInfoItem}.</p>
* <p>If {@code addDefaultEntriesAutomatically} is set to {@code true}, * <p>If {@code addDefaultEntriesAutomatically} is set to {@code true},
* some default entries are added to the top and bottom of the dialog.</p> * some default entries are added to the top and bottom of the dialog.</p>
* The dialog has the following structure: * The dialog has the following structure: