Added JavaDoc for deleteJob method.

jenkinsci · Aug 13, 2015 · 0dc5330 · 0dc5330
1 parent b9b4d78
commit 0dc5330
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/java/com/offbytwo/jenkins/JenkinsServer.java b/src/main/java/com/offbytwo/jenkins/JenkinsServer.java
@@ -288,6 +288,12 @@ public void deleteJob(String jobName) throws IOException {
         client.post("/job/" + encode(jobName) + "/doDelete");
     }
 
+    /**
+     * Delete a job from Jenkins.
+     * @param jobName The name of the job to be deleted.
+     * @param crumbFlag The crumFlag.
+     * @throws IOException In case of an failure.
+     */
     public void deleteJob(String jobName, boolean crumbFlag) throws IOException {
         client.post("/job/" + encode(jobName) + "/doDelete", crumbFlag);
     }