diff --git a/src/main/java/com/lukflug/panelstudio/ClickGUI.java b/src/main/java/com/lukflug/panelstudio/ClickGUI.java index 64e6fe0..9e7d4b5 100644 --- a/src/main/java/com/lukflug/panelstudio/ClickGUI.java +++ b/src/main/java/com/lukflug/panelstudio/ClickGUI.java @@ -33,6 +33,7 @@ public class ClickGUI implements PanelManager { /** * Constructor for the GUI. * @param inter the {@link Interface} to be used by the GUI + * @param descriptionRenderer the {@link DescriptionRenderer} used by the GUI */ public ClickGUI (Interface inter, DescriptionRenderer descriptionRenderer) { this.inter=inter; diff --git a/src/main/java/com/lukflug/panelstudio/CollapsibleContainer.java b/src/main/java/com/lukflug/panelstudio/CollapsibleContainer.java index d078200..1a796ab 100644 --- a/src/main/java/com/lukflug/panelstudio/CollapsibleContainer.java +++ b/src/main/java/com/lukflug/panelstudio/CollapsibleContainer.java @@ -43,6 +43,7 @@ public class CollapsibleContainer extends FocusableComponent implements Toggleab /** * Constructor. * @param title the caption for the container + * @param description the description for this component * @param renderer the {@link Renderer} for the container * @param open the {@link Toggleable} for {@link #open} * @param animation the animation for this container diff --git a/src/main/java/com/lukflug/panelstudio/Container.java b/src/main/java/com/lukflug/panelstudio/Container.java index 448d33b..9c44d34 100644 --- a/src/main/java/com/lukflug/panelstudio/Container.java +++ b/src/main/java/com/lukflug/panelstudio/Container.java @@ -22,6 +22,7 @@ public class Container extends FocusableComponent { /** * Constructor for a container. * @param title the caption of the container + * @param description the description for this component * @param renderer the renderer used by the container */ public Container (String title, String description, Renderer renderer) { @@ -137,6 +138,7 @@ protected Context getSubContext (Context context, int posy) { /** * Loop through all components in reverse order and check for focus requests. + * @param context for the container * @param function the function to execute in the loop */ protected void doComponentLoop (Context context, LoopFunction function) { @@ -151,7 +153,7 @@ protected void doComponentLoop (Context context, LoopFunction function) { /** - * Interface used by {@link Container#doComponentLoop(LoopFunction)}. + * Interface used by the loop. * @author lukflug */ protected interface LoopFunction { diff --git a/src/main/java/com/lukflug/panelstudio/Context.java b/src/main/java/com/lukflug/panelstudio/Context.java index d3b3da7..496775b 100644 --- a/src/main/java/com/lukflug/panelstudio/Context.java +++ b/src/main/java/com/lukflug/panelstudio/Context.java @@ -50,7 +50,8 @@ public final class Context { * Constructor that should be used when a parent is calling a method by the child. * {@link #inter} and {@link #onTop} are inherited without modification. * @param context the context of the parent - * @param border the horizontal border (left and right) for the child + * @param left the left horizontal border for the child + * @param right the right horizontal border for the child * @param offset the vertical position of the child relative to the parent's position * @param focus focus state of the parent * @param onTop whether component is in the front diff --git a/src/main/java/com/lukflug/panelstudio/DraggableContainer.java b/src/main/java/com/lukflug/panelstudio/DraggableContainer.java index 08c56e2..3a3fd27 100644 --- a/src/main/java/com/lukflug/panelstudio/DraggableContainer.java +++ b/src/main/java/com/lukflug/panelstudio/DraggableContainer.java @@ -34,6 +34,7 @@ public class DraggableContainer extends CollapsibleContainer implements FixedCom /** * Constructor. * @param title caption of the container + * @param description the description for this component * @param renderer {@link Renderer} for the container * @param open {@link Toggleable} to indicate whether the container is open or closed * @param animation the animation for opening and closing the container diff --git a/src/main/java/com/lukflug/panelstudio/FocusableComponent.java b/src/main/java/com/lukflug/panelstudio/FocusableComponent.java index 995941e..5a21baa 100644 --- a/src/main/java/com/lukflug/panelstudio/FocusableComponent.java +++ b/src/main/java/com/lukflug/panelstudio/FocusableComponent.java @@ -27,6 +27,7 @@ public class FocusableComponent implements Component { /** * Constructor. * @param title the caption for this component + * @param description the description for this component * @param renderer the {@link Renderer} for this component */ public FocusableComponent (String title, String description, Renderer renderer) { diff --git a/src/main/java/com/lukflug/panelstudio/Slider.java b/src/main/java/com/lukflug/panelstudio/Slider.java index 6f701ef..56ccc26 100644 --- a/src/main/java/com/lukflug/panelstudio/Slider.java +++ b/src/main/java/com/lukflug/panelstudio/Slider.java @@ -16,6 +16,7 @@ public abstract class Slider extends FocusableComponent { /** * Constructor. * @param title caption of the slider + * @param description the description for this component * @param renderer renderer for the slider */ public Slider(String title, String description, Renderer renderer) { diff --git a/src/main/java/com/lukflug/panelstudio/TransientComponent.java b/src/main/java/com/lukflug/panelstudio/TransientComponent.java index 1f865ee..78bb247 100644 --- a/src/main/java/com/lukflug/panelstudio/TransientComponent.java +++ b/src/main/java/com/lukflug/panelstudio/TransientComponent.java @@ -26,7 +26,9 @@ public class TransientComponent extends FocusableComponent { * @param title the title for this component * @param description the description for this component * @param renderer the renderer for this component + * @param toggle the {@link Toggleable} to be used by the user * @param component component to be opened when clicked + * @param manager the {@link PanelManager} to be used by this component */ public TransientComponent (String title, String description, Renderer renderer, Toggleable toggle, FixedComponent component, PanelManager manager) { super(title,description,renderer); diff --git a/src/main/java/com/lukflug/panelstudio/hud/HUDClickGUI.java b/src/main/java/com/lukflug/panelstudio/hud/HUDClickGUI.java index e9f5006..39ed202 100644 --- a/src/main/java/com/lukflug/panelstudio/hud/HUDClickGUI.java +++ b/src/main/java/com/lukflug/panelstudio/hud/HUDClickGUI.java @@ -30,9 +30,10 @@ public class HUDClickGUI extends ClickGUI implements Toggleable { /** * Constructor. * @param inter the interface for the ClickGUI + * @param descriptionRenderer the {@link DescriptionRenderer} used by the GUI */ - public HUDClickGUI (Interface inter, DescriptionRenderer renderer) { - super(inter,renderer); + public HUDClickGUI (Interface inter, DescriptionRenderer descriptionRenderer) { + super(inter,descriptionRenderer); components=hudComponents; } diff --git a/src/main/java/com/lukflug/panelstudio/settings/BooleanComponent.java b/src/main/java/com/lukflug/panelstudio/settings/BooleanComponent.java index d87444c..8ea8c45 100644 --- a/src/main/java/com/lukflug/panelstudio/settings/BooleanComponent.java +++ b/src/main/java/com/lukflug/panelstudio/settings/BooleanComponent.java @@ -18,6 +18,7 @@ public class BooleanComponent extends FocusableComponent { /** * Constructor. * @param title name of the setting + * @param description the description for this component * @param renderer {@link Renderer} for the component * @param setting the setting in question */ diff --git a/src/main/java/com/lukflug/panelstudio/settings/ColorComponent.java b/src/main/java/com/lukflug/panelstudio/settings/ColorComponent.java index d8a1f4e..855af35 100644 --- a/src/main/java/com/lukflug/panelstudio/settings/ColorComponent.java +++ b/src/main/java/com/lukflug/panelstudio/settings/ColorComponent.java @@ -40,6 +40,7 @@ public class ColorComponent extends CollapsibleContainer { /** * Constructor. * @param title the name of the setting + * @param description the description for this component * @param renderer the renderer for the color setting container * @param animation the animation for opening and closing * @param componentRenderer the renderer for the children of the container diff --git a/src/main/java/com/lukflug/panelstudio/settings/EnumComponent.java b/src/main/java/com/lukflug/panelstudio/settings/EnumComponent.java index cf8bdd0..c95e05a 100644 --- a/src/main/java/com/lukflug/panelstudio/settings/EnumComponent.java +++ b/src/main/java/com/lukflug/panelstudio/settings/EnumComponent.java @@ -18,6 +18,7 @@ public class EnumComponent extends FocusableComponent { /** * Constructor. * @param title name of the setting + * @param description the description for this component * @param renderer {@link Renderer} for the component * @param setting the setting in question */ diff --git a/src/main/java/com/lukflug/panelstudio/settings/NumberComponent.java b/src/main/java/com/lukflug/panelstudio/settings/NumberComponent.java index bfad861..5ff7408 100644 --- a/src/main/java/com/lukflug/panelstudio/settings/NumberComponent.java +++ b/src/main/java/com/lukflug/panelstudio/settings/NumberComponent.java @@ -21,6 +21,7 @@ public class NumberComponent extends Slider { /** * Constructor. * @param text name of the setting + * @param description the description for this component * @param renderer {@link Renderer} for the component * @param setting the setting in question * @param min minimum value for the setting diff --git a/src/main/java/com/lukflug/panelstudio/theme/RendererBase.java b/src/main/java/com/lukflug/panelstudio/theme/RendererBase.java index 65d0f37..2d4d314 100644 --- a/src/main/java/com/lukflug/panelstudio/theme/RendererBase.java +++ b/src/main/java/com/lukflug/panelstudio/theme/RendererBase.java @@ -23,6 +23,8 @@ public abstract class RendererBase implements Renderer { * @param height default component height * @param offset default vertical offset * @param border default horizontal border + * @param left default left border + * @param right default right border */ public RendererBase (int height, int offset, int border, int left, int right) { this.height=height;