Merge pull request TheAlgorithms#24 from zacharyjones123/master

AnupKumarPanwar · web-flow · commit 51054645c2a7 · 2017-04-17T20:07:13.000+05:30
Added JavaDoc to BinarySearch.java
diff --git a/Binary Search.java b/Binary Search.java
@@ -1,10 +1,23 @@
 import java.util.Scanner;
 
+/**
+ * Implements a Binary Search in Java
+ *
+ * @author unknown
+ */
 class BinarySearch
 {
+	/**
+	 * This method implements the Binary Search
+	 *
+	 * @param array The array to make the binary search
+	 * @param key The number you are looking for
+	 * @param lb The lower bound
+	 * @param up The  upper bound
+	 * @return the location of the key
+	 **/
 	public static int BS(int array[], int key, int lb, int ub)
-	{
-		if (lb>ub) 
+	{		if (lb>ub) 
 		{
 			return -1;
 		}
@@ -25,6 +38,14 @@ else if (key>array[mid])
 		}
 	}
 
+	
+	/**
+	 * This is the main method of Binary Search
+	 *
+	 * @author Unknown
+	 * @param args Command line parameters
+	 */
+
 	public static void main(String[] args) 
 	{
 		Scanner input=new Scanner(System.in);
@@ -50,4 +71,4 @@ public static void main(String[] args)
 			System.out.println("Not found");
 		}
 	}
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,23 @@`
`1`	`1`	`import java.util.Scanner;`
`2`	`2`
	`3`	`+/**`
	`4`	`+ * Implements a Binary Search in Java`
	`5`	`+ *`
	`6`	`+ * @author unknown`
	`7`	`+ */`
`3`	`8`	`class BinarySearch`
`4`	`9`	`{`
	`10`	`+ /**`
	`11`	`+ * This method implements the Binary Search`
	`12`	`+ *`
	`13`	`+ * @param array The array to make the binary search`
	`14`	`+ * @param key The number you are looking for`
	`15`	`+ * @param lb The lower bound`
	`16`	`+ * @param up The upper bound`
	`17`	`+ * @return the location of the key`
	`18`	`+ **/`
`5`	`19`	`public static int BS(int array[], int key, int lb, int ub)`
`6`		`- {`
`7`		`- if (lb>ub)`
	`20`	`+ { if (lb>ub)`
`8`	`21`	`{`
`9`	`22`	`return -1;`
`10`	`23`	`}`
`@@ -25,6 +38,14 @@ else if (key>array[mid])`
`25`	`38`	`}`
`26`	`39`	`}`
`27`	`40`
	`41`	`+`
	`42`	`+ /**`
	`43`	`+ * This is the main method of Binary Search`
	`44`	`+ *`
	`45`	`+ * @author Unknown`
	`46`	`+ * @param args Command line parameters`
	`47`	`+ */`
	`48`	`+`
`28`	`49`	`public static void main(String[] args)`
`29`	`50`	`{`
`30`	`51`	`Scanner input=new Scanner(System.in);`
`@@ -50,4 +71,4 @@ public static void main(String[] args)`
`50`	`71`	`System.out.println("Not found");`
`51`	`72`	`}`
`52`	`73`	`}`
`53`		`-}`
	`74`	`+}`