JAL-3878 Add javadocs to created classes and reformat code.

[jalview.git] / src / jalview / ws2 / MenuEntryProviderI.java

diff --git a/src/jalview/ws2/MenuEntryProviderI.java b/src/jalview/ws2/MenuEntryProviderI.java
index ac08c49..b6f0e9c 100755 (executable)
--- a/src/jalview/ws2/MenuEntryProviderI.java
+++ b/src/jalview/ws2/MenuEntryProviderI.java
@@ -4,9 +4,25 @@ import javax.swing.JMenu;
 
 import jalview.gui.AlignFrame;
 
+/**
+ * Functional interface provided by {@link jalview.ws2.operations.Operation}
+ * instances to construct the menu entry for the operations. The instances are
+ * passed to the {@link jalview.gui.WebServicesMenuBuilder} and called during
+ * menu construction.
+ * 
+ * @author mmwarowny
+ */
 @FunctionalInterface
 public interface MenuEntryProviderI
 {
-  public void buildMenu(JMenu parent, JalviewWebServiceI<?> service,
-      AlignFrame frame);
+  /**
+   * Build menu entries directly under the given menu. This method is called by
+   * {@link jalview.gui.WebServicesMenuBuilder} during menu construction.
+   * 
+   * @param parent
+   *          parent menu
+   * @param frame
+   *          current alignFrame
+   */
+  public void buildMenu(JMenu parent, AlignFrame frame);
 }