Fix javadoc generation

jenkinsci · Jun 25, 2020 · 2a21d34 · 2a21d34
1 parent ca22e09
commit 2a21d34
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/src/main/java/hudson/plugins/depgraph_view/AbstractDependencyGraphAction.java b/src/main/java/hudson/plugins/depgraph_view/AbstractDependencyGraphAction.java
@@ -71,8 +71,11 @@ public abstract class AbstractDependencyGraphAction implements Action {
 
     /**
      * This method is called via AJAX to obtain the context menu for this model object, but we don't have one...
+     * @param request StaplerRequest
+     * @param response StaplerResponse
+     * @return the ContextMenu we dont thave any
      */
-    public ContextMenu doContextMenu(StaplerRequest request, StaplerResponse response) throws Exception {
+    public ContextMenu doContextMenu(StaplerRequest request, StaplerResponse response) {
         return new ContextMenu();
     }
 
@@ -98,8 +101,12 @@ public void doEdge(StaplerRequest req, StaplerResponse rsp) throws IOException,
 
     /**
      * graph.{png,gv,...} is mapped to the corresponding output
+     * @param req StaplerRequest
+     * @param rsp StaplerResponse
+     * @throws IOException if dot fails
+     * @throws ServletException
      */
-    public void doDynamic(StaplerRequest req, StaplerResponse rsp)  throws IOException, ServletException, InterruptedException {
+    public void doDynamic(StaplerRequest req, StaplerResponse rsp)  throws IOException, ServletException {
         String path = req.getRestOfPath();
         SupportedImageType imageType;
         try {
@@ -143,6 +150,9 @@ public void doDynamic(StaplerRequest req, StaplerResponse rsp)  throws IOExcepti
     /**
      * Execute the dot command with given input and output stream
      * @param type the parameter for the -T option of the graphviz tools
+     * @param input the input stream to connect to dot execution
+     * @param output the output stream to connect to dot execution
+     * @throws IOException in case of dot execution errors
      */
     protected void runDot(OutputStream output, InputStream input, String type)
             throws IOException {

diff --git a/src/main/java/hudson/plugins/depgraph_view/model/graph/EdgeProvider.java b/src/main/java/hudson/plugins/depgraph_view/model/graph/EdgeProvider.java
@@ -24,7 +24,6 @@
 
 import hudson.ExtensionPoint;
 import hudson.model.Job;
-import hudson.plugins.depgraph_view.model.graph.DependencyGraphModule;
 import hudson.plugins.depgraph_view.model.graph.edge.Edge;
 
 /**
@@ -34,8 +33,8 @@
  * to the DependencyGraph which gets drawn. Note that in order to add your own
  * EdgeProvider you must not annotate the corresponding subclass with {@link hudson.Extension}
  * but instead add a {@link com.google.inject.Module} with a {@link com.google.inject.multibindings.Multibinder}
- * which has the {@link hudson.Extension} annotation. For example see {@link DependencyGraphModule}
- * and {@link DependencyGraphEdgeProvider}
+ * which has the {@link hudson.Extension} annotation. For example see {@link hudson.plugins.depgraph_view.model.graph.DependencyGraphModule}
+ * and {@link hudson.plugins.depgraph_view.model.graph.edge.DependencyGraphEdgeProvider}
  */
 @Deprecated
 public interface EdgeProvider extends ExtensionPoint {