From 49c5ac26b543babf8d0e9eb3211bb03da6bcaa21 Mon Sep 17 00:00:00 2001 From: Karl-Philipp Richter Date: Wed, 26 Dec 2018 18:55:11 +0100 Subject: [PATCH] Fix some javadoc issues in order to make deployment work (#13) --- .../flexdock/docking/DockingConstants.java | 3 -- .../org/flexdock/docking/DockingManager.java | 27 +++++----- .../org/flexdock/docking/DockingPort.java | 51 +++++++++++++++---- .../org/flexdock/docking/DockingStub.java | 4 ++ .../docking/defaults/DefaultDockingPort.java | 10 ++-- .../defaults/DefaultDockingStrategy.java | 36 ++++++------- .../defaults/DefaultRegionChecker.java | 2 + .../docking/defaults/DockingSplitPane.java | 2 +- .../flexdock/docking/event/DockingEvent.java | 20 +++++--- .../flexdock/docking/state/FloatManager.java | 2 +- .../flexdock/docking/state/FloatingGroup.java | 2 +- .../org/flexdock/util/DockingUtility.java | 2 +- .../java/org/flexdock/util/RootWindow.java | 2 + .../java/org/flexdock/util/SwingUtility.java | 26 +++++----- .../java/org/flexdock/util/Utilities.java | 15 +++--- .../demos/maximizing/SimpleInternalFrame.java | 2 - 16 files changed, 124 insertions(+), 82 deletions(-) diff --git a/flexdock-core/src/main/java/org/flexdock/docking/DockingConstants.java b/flexdock-core/src/main/java/org/flexdock/docking/DockingConstants.java index 0d78063..18c1b82 100644 --- a/flexdock-core/src/main/java/org/flexdock/docking/DockingConstants.java +++ b/flexdock-core/src/main/java/org/flexdock/docking/DockingConstants.java @@ -69,15 +69,12 @@ public interface DockingConstants { * * @see java.beans.PropertyChangeListener * @see Dockable#addPropertyChangeListener(java.beans.PropertyChangeListener) - * @see org.flexdock.view.Titlebar */ String PIN_ACTION = "pin"; /** * A constant representing a "close" action. Such actions are added to title * bars to enable the close effect. - * - * @see org.flexdock.view.Titlebar */ String CLOSE_ACTION = "close"; diff --git a/flexdock-core/src/main/java/org/flexdock/docking/DockingManager.java b/flexdock-core/src/main/java/org/flexdock/docking/DockingManager.java index 5584fbb..c930ac8 100644 --- a/flexdock-core/src/main/java/org/flexdock/docking/DockingManager.java +++ b/flexdock-core/src/main/java/org/flexdock/docking/DockingManager.java @@ -652,12 +652,12 @@ public static boolean isFloatingEnabled() { /** * Indicates whether tabbed layouts are supported by default for - * {@code DockingPorts} with a single {@code Dockable} in the CENTER region. - * This is a global default setting and applies to any DockingPort} + * {@code DockingPorts} with a single {@code Dockable} in the {@link DockingConstants#CENTER} region. + * This is a global default setting and applies to any {@code DockingPort} * that does not have a specific contradictory local setting. *

* This method defers processing to - * {@code org.flexdock.docking.props.PropertyManager.getDockingPortRoot()}. + * {@link org.flexdock.docking.props.PropertyManager#getDockingPortRoot()}. * As such, there are multiple "scopes" at which this property may be * overridden. * @@ -1293,8 +1293,8 @@ public static RootDockingPortInfo getRootDockingPortInfo(Component comp) { * * @return {@code true} if the current layout model was succesfully stored, * {@code false} otherwise. - * @throws IOException - * @throws PersisterException + * @throws IOException if an I/O exception occurs during storage + * @throws PersistenceException wraps all specific exceptions which can occur during storage * @see #getLayoutManager() * @see #setLayoutManager(LayoutManager) * @see LayoutManager#store() @@ -1326,8 +1326,8 @@ public static boolean storeLayoutModel() throws IOException, * * @return {@code true} if the current layout model was succesfully loaded, * {@code false} otherwise. - * @throws IOException - * @throws PersisterException + * @throws IOException if an I/O exception occurs during loading + * @throws PersistenceException wraps all specific exceptions which can occur during loading * @see #loadLayoutModel(boolean) * @see LayoutManager#load() */ @@ -1358,10 +1358,11 @@ public static boolean loadLayoutModel() throws IOException, * previous layout model found in storage). If a problem occurs during the * loading process, an {@code IOException} is thrown. * + * @param restore whether or not to restore the loaded layout * @return {@code true} if the current layout model was succesfully loaded, * {@code false} otherwise. - * @throws IOException - * @throws PersisterException + * @throws IOException if an I/O exception occurs during loading + * @throws PersistenceException wraps all specific exceptions which can occur during loading * @see #getLayoutManager() * @see #setLayoutManager(LayoutManager) * @see #restoreLayout(boolean) @@ -1394,7 +1395,6 @@ public static boolean loadLayoutModel(boolean restore) throws IOException, * * @return {@code true} if the in-memory layout model was properly restored * to the application view, {@code false} otherwise. - * @throws PersisterException * @see #restoreLayout(boolean) * @see #getLayoutManager() * @see #setLayoutManager(LayoutManager) @@ -1435,7 +1435,8 @@ public static boolean restoreLayout() { * storage into memory before synchronizing the application view. * @return {@code true} if the in-memory layout model was properly restored * to the application view, {@code false} otherwise. - * @throws PersisterException + * @throws IOException if an I/O exception occurs during restoring + * @throws PersistenceException wraps all specific exceptions which can occur during restoring * @see #getLayoutManager() * @see #setLayoutManager(LayoutManager) * @see LayoutManager#restore(boolean) @@ -2742,7 +2743,7 @@ public static void setDragPreview(DragPreview dragPreview) { * obtaining the {@code Dockable} associated to the component via * {@link #getDockable(Component)}. * - * @param comp + * @param comp the component to toggle maximization for * @see #toggleMaximized(Dockable) */ public static void toggleMaximized(Component comp) { @@ -2766,7 +2767,7 @@ public static void toggleMaximized(Component comp) { * {@code DockingPort} is asked to return to its original state and the * {@code Dockable} is returned to its original {@code DockingPort}. * - * @param dockable + * @param dockable the dockable to toggle maximization for */ public static void toggleMaximized(Dockable dockable) { DockingPort rootPort = getRootDockingPort(dockable.getComponent()); diff --git a/flexdock-core/src/main/java/org/flexdock/docking/DockingPort.java b/flexdock-core/src/main/java/org/flexdock/docking/DockingPort.java index 7644e0e..18a52c0 100644 --- a/flexdock-core/src/main/java/org/flexdock/docking/DockingPort.java +++ b/flexdock-core/src/main/java/org/flexdock/docking/DockingPort.java @@ -44,6 +44,10 @@ public interface DockingPort extends DockingListener, DockingMonitor { /** * Returns a boolean indicating whether or not docking is allowed within the * specified region. Used by {@code DockingManager} during drag operations. + * + * @param comp the component to check + * @param region the region to check + * @return {@code true} if docking is allowed for {@code comp} in {@code region}, {@code false} otherwise */ boolean isDockingAllowed(Component comp, String region); @@ -53,20 +57,27 @@ public interface DockingPort extends DockingListener, DockingMonitor { void clear(); /** - * Docks the specified Dockable in the specified region. The - * {@code Dockable's} {@code getDockable()} component is used as the docking - * component. + * Docks the specified Dockable in the specified region. + * + * @param dockable the dockable to dock + * @param region the region where to dock + * @return {@code true} if the docking was successful, {@code false} otherwise */ boolean dock(Dockable dockable, String region); /** - * Docks the specified Component in the specified region. Returns - * {@code true} for success and {@code false} for failure. + * Docks the specified component in the specified region. + * + * @param comp the component to dock + * @param region the region where to dock + * @return {@code true} for success and {@code false} for failure */ boolean dock(Component comp, String region); /** * Returns a reference to the currently docked component. + * + * @return as described */ Component getDockedComponent(); @@ -75,6 +86,9 @@ public interface DockingPort extends DockingListener, DockingMonitor { * Returns null if there is no Dockable there. If a tabbed layout is * present, this method will return the Dockable in the currently selected * tab. + * + * @param region the region to retrieve for + * @return as described */ Dockable getDockable(String region); @@ -83,6 +97,9 @@ public interface DockingPort extends DockingListener, DockingMonitor { * Returns null if there is no Component there. If a tabbed layout is * present, this method will return the Component in the currently selected * tab. + * + * @param region the region to retrieve for + * @return as described */ Component getComponent(String region); @@ -96,6 +113,8 @@ public interface DockingPort extends DockingListener, DockingMonitor { * instances, but it should also be consistent from JVM to JVM so that the * association between a {@code DockingPort} instance and its ID can be * remembered from session to session. + * + * @return as described */ String getPersistentId(); @@ -109,14 +128,19 @@ public interface DockingPort extends DockingListener, DockingMonitor { void setPersistentId(String id); /** - * Indicates whether or not the specified component is a child component + * Checks whether or not the specified component is a child component * docked within the {@code DockingPort}. + * + * @param comp the component to check + * @return {@code true} if {@code comp} is a parent docking port, {@code false} otherwise */ boolean isParentDockingPort(Component comp); /** - * Removes the specified Component in from the {@code DockingPort}. Returns - * {@code true} for success and {@code false} for failure. + * Removes the specified Component in from the {@code DockingPort}. + * + * @param comp the component to undock + * @return {@code true} for success and {@code false} for failure */ boolean undock(Component comp); @@ -128,17 +152,17 @@ public interface DockingPort extends DockingListener, DockingMonitor { * {@code SOUTH_REGION}, {@code EAST_REGION}, {@code WEST_REGION}, or * {@code UNKNOWN_REGION}. * + * @param point the point to retrieve the region for * @return the region containing the specified {@code Point}. */ - String getRegion(Point p); + String getRegion(Point point); /** * Returns the value of the property with the specified key. Only properties * added with {@code putClientProperty} will return a non-{@code null} * value. * - * @param key - * the being queried + * @param key the key being queried * @return the value of this property or {@code null} * @see javax.swing.JComponent#getClientProperty(java.lang.Object) */ @@ -148,6 +172,8 @@ public interface DockingPort extends DockingListener, DockingMonitor { * Adds an arbitrary key/value "client property" to this {@code DockingPort}. * {@code null} values are allowed. * + * @param key the key being set + * @param value the value to set for {@code key} * @see javax.swing.JComponent#putClientProperty(java.lang.Object, * java.lang.Object) */ @@ -178,6 +204,7 @@ public interface DockingPort extends DockingListener, DockingMonitor { * Returns the {@code DockingStrategy} instance used by this * {@code DockingPort} for docking operations. * + * @return as described * @see DockingStrategy */ DockingStrategy getDockingStrategy(); @@ -201,6 +228,8 @@ public interface DockingPort extends DockingListener, DockingMonitor { * method will return {@code false}. If the this {@code DockingPort} is not * validated and/or is not part of a container hierarchy, this method should * return {@code true}. + * + * @return as described */ boolean isRoot(); diff --git a/flexdock-core/src/main/java/org/flexdock/docking/DockingStub.java b/flexdock-core/src/main/java/org/flexdock/docking/DockingStub.java index b8e1db7..cfc4217 100644 --- a/flexdock-core/src/main/java/org/flexdock/docking/DockingStub.java +++ b/flexdock-core/src/main/java/org/flexdock/docking/DockingStub.java @@ -31,6 +31,7 @@ public interface DockingStub { * operations. The component may or may not be the same as the Component * returned by {@code getFrameDragSource()}. * + * @return as described * @see #getFrameDragSource() */ Component getDragSource(); @@ -46,6 +47,7 @@ public interface DockingStub { * reposition" behavior will supercede any "drag-to-dock" behavior while * this stub is in a floating state. * + * @return as described * @see #getDragSource() */ Component getFrameDragSource(); @@ -63,6 +65,8 @@ public interface DockingStub { *

* The framework performs indexing on the persistent ID. Consequently, this * method may not return a {@code null} reference. + * + * @return as described */ String getPersistentId(); diff --git a/flexdock-core/src/main/java/org/flexdock/docking/defaults/DefaultDockingPort.java b/flexdock-core/src/main/java/org/flexdock/docking/defaults/DefaultDockingPort.java index 91ced82..297b406 100644 --- a/flexdock-core/src/main/java/org/flexdock/docking/defaults/DefaultDockingPort.java +++ b/flexdock-core/src/main/java/org/flexdock/docking/defaults/DefaultDockingPort.java @@ -295,8 +295,6 @@ public void invalidateLayout(Container target) { /** * Creates a new {@code DefaultDockingPort} with a persistent ID equal to * the {@code String} value of this a random UUID. - * - * @see org.flexdock.util.UUID */ public DefaultDockingPort() { this(UUID.randomUUID().toString()); @@ -1686,7 +1684,7 @@ private Component setComponent(Component c) { * there i s a container hierarchy to manage tabbed interfaces, split * layouts, and sub-docking. As components are removed from this hierarchy, * the hierarchy itself must be reevaluated. Removing a component from a - * child code>DefaultDockingPort} within a {@code JSplitPane} renders the + * child {@code DefaultDockingPort} within a {@code JSplitPane} renders the * child {@code DefaultDockingPort} unnecessary, which, in turn, renders the * notion of splitting the layout with a {@code JSplitPane} unnecessary * (since there are no longer two components to split the layout between). @@ -1805,7 +1803,7 @@ protected boolean isValidDockableChild(Component c, Class desiredClass) { * * @param listener * the {@code DockingListener} to add to this {@code DockingPort}. - * @see DockingMonitor#addDockingListener(DockingListener) + * @see org.flexdock.docking.event.DockingMonitor#addDockingListener(DockingListener) * @see #getDockingListeners() * @see #removeDockingListener(DockingListener) */ @@ -1823,7 +1821,7 @@ public void addDockingListener(DockingListener listener) { * * @return an array of all {@code DockingListeners} added to this * {@code DockingPort}. - * @see DockingMonitor#getDockingListeners() + * @see org.flexdock.docking.event.DockingMonitor#getDockingListeners() * @see #addDockingListener(DockingListener) * @see #removeDockingListener(DockingListener) */ @@ -1843,7 +1841,7 @@ public DockingListener[] getDockingListeners() { * @param listener * the {@code DockingListener} to remove from this * {@code DockingPort} - * @see DockingMonitor#removeDockingListener(DockingListener) + * @see org.flexdock.docking.event.DockingMonitor#removeDockingListener(DockingListener) * @see #addDockingListener(DockingListener) * @see #getDockingListeners() */ diff --git a/flexdock-core/src/main/java/org/flexdock/docking/defaults/DefaultDockingStrategy.java b/flexdock-core/src/main/java/org/flexdock/docking/defaults/DefaultDockingStrategy.java index af1c810..d2c0870 100644 --- a/flexdock-core/src/main/java/org/flexdock/docking/defaults/DefaultDockingStrategy.java +++ b/flexdock-core/src/main/java/org/flexdock/docking/defaults/DefaultDockingStrategy.java @@ -100,34 +100,34 @@ public static Dockable getSibling(Dockable dockable) { /** * Returns the sibling {@code Dockable} relative to the specified - * {@code Dockable's} supplied region in the current docking layout. If + * {@code Dockable}'s supplied region in the current docking layout. If * {@code dockable} is {@code null} or {@code region} is either invalid or * equal to {@code CENTER_REGION}, then this method returns a {@code null} * reference. *

* If the specified {@code Dockable} is in a {@code DockingPort} that - * equally splits the layout between two {@code Dockables} in a fashion that + * equally splits the layout between two {@code Dockable}s in a fashion that * matches up with the specified region, then the immediate sibling * {@code Dockable} is returned. Otherwise, a fuzzy search is performed * throughout the docking layout for a {@code Dockable} that "looks like" it * is docked to the supplied region of the specified {@code Dockable} from a * visual standpoint. *

- * For instance, a docking layout may consist of four quadrants Dockable1 - * (top-left), Dockable2 (top-right), Dockable3 - * (bottom-left) and Dockable4 (bottom-right). The layout is built - * by docking Dockable2>/i> to the {@code EAST_REGION} of Dockable1, - * Dockable3 to the {@code SOUTH_REGION} of Dockable1, and - * Dockable4 to the {@code SOUTH_REGION} of Dockable2. - * Within this layout, Dockable1 and Dockable3 are immediate - * siblings, as are Dockable2 and Dockable4. Thus, - * requesting sibling NORTH_REGION of Dockable3 will easily yield - * Dockable1. However, Dockable3 has no immediate + * For instance, a docking layout may consist of four quadrants {@code dockable1} + * (top-left), {@code dockable2} (top-right), {@code dockable3} + * (bottom-left) and {@code dockable4} (bottom-right). The layout is built + * by docking {@code dockable2} to the {@code EAST_REGION} of {@code dockable1}, + * {@code dockable3} to the {@code SOUTH_REGION} of {@code dockable1}, and + * {@code dockable4} to the {@code SOUTH_REGION} of {@code dockable2}. + * Within this layout, {@code dockable1} and {@code dockable3} are immediate + * siblings, as are {@code dockable2} and {@code dockable4}. Thus, + * requesting sibling NORTH_REGION of {@code dockable3} will easily yield + * {@code dockable1}. However, {@code dockable3} has no immediate * {@code EAST_REGION} sibling. In this case, a fuzzy search through the * layout is performed to determine the visual sibling, and this method - * returns Dockable4. Likewise, this method will return a + * returns {@code dockable4}. Likewise, this method will return a * {@code null} reference for the {@code WEST_REGION} sibling of - * Dockable3}, since there are no {@code Dockables} in the visual layout + * {@code dockable3}, since there are no {@code Dockable}s in the visual layout * to the west of this {@code Dockable}. * * @param dockable @@ -287,7 +287,7 @@ public static String findRegion(Component comp) { * method may return {@code false} if the territory is blocked. Finally, * this method will return {@code false} if the specified {@code Dockable} * is already docked within the supplied region of the specified - * Dockables. Classes * implementing this interface will be responsible for sending Dockables into * DockingFrames and managing the grouping of floating Dockables. - *
+ * * Sending a Dockable into a floating DockingFrame is relatively straightforward * when supplied the Dockable and a dialog owner. However, state must be maintained * for each FloatingGroup to allow the system to track which Dockables diff --git a/flexdock-core/src/main/java/org/flexdock/docking/state/FloatingGroup.java b/flexdock-core/src/main/java/org/flexdock/docking/state/FloatingGroup.java index 8fbbb14..61982d9 100644 --- a/flexdock-core/src/main/java/org/flexdock/docking/state/FloatingGroup.java +++ b/flexdock-core/src/main/java/org/flexdock/docking/state/FloatingGroup.java @@ -35,7 +35,7 @@ * DockingFrame to be recreated and displayed with the previous screen bounds and all * of the Dockables contained within the group to be restored to their previous state * within the DockingFrame. - *
+ * * In addition to providing persistent state across application sessions, the FloatingGroup * allows for a floating Dockable to be closed and then later restored to its original * floating state within the same JVM session. The currently installed FloatManager may diff --git a/flexdock-core/src/main/java/org/flexdock/util/DockingUtility.java b/flexdock-core/src/main/java/org/flexdock/util/DockingUtility.java index 6121cf3..6d2d631 100644 --- a/flexdock-core/src/main/java/org/flexdock/util/DockingUtility.java +++ b/flexdock-core/src/main/java/org/flexdock/util/DockingUtility.java @@ -445,7 +445,7 @@ public static boolean isMinimized(Dockable dockable) { * @return an {@code int} value representing the current minimization * constraint for the specified {@code Dockable} * @see MinimizationManager#UNSPECIFIED_LAYOUT_CONSTRAINT - * @see DockingState#getMinimizedConstraint()() + * @see DockingState#getMinimizedConstraint() * @see DockingManager#getLayoutManager() * @see org.flexdock.docking.state.LayoutManager#getDockingState(Dockable) */ diff --git a/flexdock-core/src/main/java/org/flexdock/util/RootWindow.java b/flexdock-core/src/main/java/org/flexdock/util/RootWindow.java index bdf9798..1c7b440 100644 --- a/flexdock-core/src/main/java/org/flexdock/util/RootWindow.java +++ b/flexdock-core/src/main/java/org/flexdock/util/RootWindow.java @@ -115,6 +115,7 @@ public static RootWindow getRootContainer(Component c) { * * @param c * the {@code Component} we wish to check + * @return {@code true} if {@code c} is a valid root container, {@code false} otherwise */ public static boolean isValidRootContainer(Component c) { return c != null @@ -151,6 +152,7 @@ private static void populateWindowList(RootWindow win, HashSet winCache, /** * Creates a new {@code RootSwingContainer} wrapping the specified * component. + * @param root the component to wrap */ protected RootWindow(Component root) { setMaximizationLayer(DEFAULT_MAXED_LAYER); diff --git a/flexdock-core/src/main/java/org/flexdock/util/SwingUtility.java b/flexdock-core/src/main/java/org/flexdock/util/SwingUtility.java index 086ccac..01971d8 100644 --- a/flexdock-core/src/main/java/org/flexdock/util/SwingUtility.java +++ b/flexdock-core/src/main/java/org/flexdock/util/SwingUtility.java @@ -334,11 +334,11 @@ public static void activateWindow(Component c) { /* Color utility */ /** - * @param color - * @param factor + * @param color the color to brighten + * @param factor the factor by which the color ought to be brightened * @return a new color, brighter than the one passed as argument by a percentage factor * - *
author Cyril Gambis - [Mar 17, 2005] + * @author Cyril Gambis - [Mar 17, 2005] */ public static Color brighter(Color color, double factor) { int red = color.getRed(); @@ -363,21 +363,21 @@ public static Color brighter(Color color, double factor) { } /** - * @param color - * @param factor + * @param color the color to darken + * @param factor the factor by which the color ought to be darkened * @return a new color, darker than the one passed as argument by a percentage factor * - *
author Cyril Gambis - [Mar 17, 2005] + * @author Cyril Gambis - [Mar 17, 2005] */ public static Color darker(Color color, double factor) { return new Color(Math.max((int) (color.getRed() * factor), 0), Math.max((int) (color.getGreen() * factor), 0), Math.max((int) (color.getBlue() * factor), 0)); } /** - * @param color + * @param color the color to transform to grayscale * @return the grey color corresponding to the color passed as parameter * - *
author Cyril Gambis - [Mar 17, 2005] + * @author Cyril Gambis - [Mar 17, 2005] */ public static Color grayScale(Color color) { int grayTone = ((color.getRed() + color.getGreen() + color.getBlue())/3); @@ -453,18 +453,18 @@ public static int getSplitPaneSize(JSplitPane splitPane) { /** * Moves the supplied JSplitPane divider to the specified proportion. - * Valid values for proportion range from 0.0F + * Valid values for proportion range from 0.0F * to 1.0F. For example, a proportion of 0.3F will move the * divider to 30% of the "size" (width for horizontal split, height for vertical split) of the * split container that contains the specified Dockable. If a proportion of less - * than 0.0F is supplied, the value 0.0F is used. If a proportion - * greater than 1.0F is supplied, the value 1.0F is used. - *
+ * than 0.0F is supplied, the value 0.0F is used. If a proportion + * greater than 1.0F is supplied, the value 1.0F is used. + * * This method should be effective regardless of whether the split layout in question has been fully realized * and is currently visible on the screen. This should alleviate common problems associated with setting * percentages of unrealized Component dimensions, which are initially 0x0 before * the Component has been rendered to the screen. - *
+ * * If the specified JSplitPane is null, then this method returns with no action * taken. * diff --git a/flexdock-core/src/main/java/org/flexdock/util/Utilities.java b/flexdock-core/src/main/java/org/flexdock/util/Utilities.java index 4e0692a..82686a5 100644 --- a/flexdock-core/src/main/java/org/flexdock/util/Utilities.java +++ b/flexdock-core/src/main/java/org/flexdock/util/Utilities.java @@ -527,15 +527,16 @@ public static void put(Map map, Object key, Object value) { * It should be understood that this method will not function properly for * inaccessible fields in the presence of a {@code SecurityManager}. Nor * will it function properly for non-existent fields (if a field called - * {@code fieldName} does not exist on the class). All {@code Throwables} + * {@code fieldName} does not exist on the class). All {@code Throwable}s * encountered by this method will be caught and eaten and the method will * return {@code false}. This works under the assumption that the operation * might likely fail because the method itself is, in reality, a convenience * hack. Therefore, specifics of any generated errors on the call stack are - * discarded and only the final outcome ({@code true/false} of the - * operation is deemed relevant. If call stack data is required within - * the application for any thrown exceptions, then this method should not be - * used.} + * discarded and only the final outcome ({@code true}/{@code false}) of the + * operation is deemed relevant. + * + * If call stack data is required within the application for any thrown + * exceptions, then this method should not be used. * * @param obj * the object for which the represented field's value is to be @@ -544,6 +545,7 @@ public static void put(Map map, Object key, Object value) { * the name of the field to be set * @param value * the new value for the field of {@code obj} being modified + * @return as described * @see Object#getClass() * @see Class#getDeclaredField(java.lang.String) * @see Field#isAccessible() @@ -599,7 +601,7 @@ public static boolean setValue(Object obj, String fieldName, Object value) { * will it function properly for non-existent fields (if a field called * {@code fieldName} does not exist on the class). All {@code Throwables} * encountered by this method will be rethrown as - * {@code IllegalAccessException}. For wrapped {@code Throwables}, the + * {@code IllegalAccessException}. For wrapped {@code Throwable}s, the * original cause can be accessed via {@code IllegalAccessException's} * {@code getCause()} method. * @@ -611,6 +613,7 @@ public static boolean setValue(Object obj, String fieldName, Object value) { * @return the value of the represented field in object {@code obj}; * primitive values are wrapped in an appropriate object before * being returned + * @throws IllegalAccessException all {@code Throwable}s as described * @see Object#getClass() * @see Class#getDeclaredField(java.lang.String) * @see Field#isAccessible() diff --git a/flexdock-demo/src/main/java/org/flexdock/demos/maximizing/SimpleInternalFrame.java b/flexdock-demo/src/main/java/org/flexdock/demos/maximizing/SimpleInternalFrame.java index 2e002f8..13a370b 100644 --- a/flexdock-demo/src/main/java/org/flexdock/demos/maximizing/SimpleInternalFrame.java +++ b/flexdock-demo/src/main/java/org/flexdock/demos/maximizing/SimpleInternalFrame.java @@ -75,8 +75,6 @@ public class SimpleInternalFrame extends JPanel { /** * Constructs a SimpleInternalFrame with an empty title. - * - * @param title the initial title */ public SimpleInternalFrame() { this(null, "", null, null);