Added some meaningfull method and class level comments

rajedan · rajedan · commit c06204f46bb8 · 2017-10-29T09:18:10.000+05:30
diff --git a/JavaDateAndTime.java b/JavaDateAndTime.java
@@ -6,6 +6,13 @@
 public class JavaDateAndTime {
     static List<String> days = Arrays.asList("SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY");
     
+    /**
+     * Gives the Day of the week(SUNDAY,MONDAY...) based on the passed params
+     * @param day
+     * @param month
+     * @param year
+     * @return
+     */
     public static String getDay(String day, String month, String year) {
           
         int y = Integer.parseInt(year);
diff --git a/University.java b/University.java
@@ -1,7 +1,14 @@
+/**
+ * This class represents University and contains it's child domain classes(Course, Student, Sem, Department and Institute)
+ */
 package javacodes;
 
 import java.util.*;
 
+/**
+ * This class is to represnt a Student
+ *
+ */
 class Students
 {
     String name="";
@@ -34,6 +41,11 @@ void getstu()
         System.out.println(name+"\t"+roll+"\t"+cgpa);
     }
 }
+
+/**
+ * This class is to represent a Semester with containing students and other information
+ *
+ */
 class Sem
 {   
     ArrayList<Students> li;
@@ -87,6 +99,10 @@ void showsem()
         }
     }
 }
+/**
+ * This class represnts a Course in a Institute
+ *
+ */
 class Course
 {
     String name;
@@ -136,6 +152,10 @@ void showcourse()
         }
     }
 }
+/**
+ * This class represents a Department in a Institute
+ *
+ */
 class Department
 {
    String name;
@@ -185,6 +205,10 @@ void showdept()
         }
     } 
 }
+/**
+ * This class represents an Institute
+ *
+ */
 class Institute
 {
   String name;
@@ -234,6 +258,10 @@ void showinst()
         }
     }   
 }
+/**
+ * This class represents a University containing one or more Institute
+ *
+ */
 public class University {
     
     public static void main(String[] args)
diff --git a/WebGraph.java b/WebGraph.java
@@ -1,5 +1,7 @@
 package javacodes;
-
+/**
+ * This class is to represent a Graph and to perform some operation in Graph
+ */
 import java.util.*;
  
 
@@ -11,6 +13,10 @@ class WebGraph
    private int dist[]; 
    private int par[]; 
     
+   /**
+    * Constructor to create a WebGraph
+    * @param v
+    */
     WebGraph(int v)
     {
         V = v;
@@ -27,13 +33,21 @@ class WebGraph
         }
     }
  
-   
+   /**
+    * This is to add an edge in the WebGraph with Vertices v and Weight w
+    * @param v
+    * @param w
+    */
     void addEdge(int v,int w)
     {
         adj[v].add(w);
     }
  
    
+    /**
+     * This api performs Breadth First Search in (this)WebGraph
+     * @param s
+     */
     void BFS(int s)
     {
         
@@ -80,6 +94,13 @@ void BFS(int s)
         }
     }
     
+    /**
+	 * Thus api prints a path(showing all the vertices in between s and d
+	 * vertices) from Source vertices s to Destination vertices d
+	 * 
+	 * @param s
+	 * @param d
+	 */
     void path(int s,int d)
     {
         BFS(s);
@@ -97,6 +118,9 @@ void path(int s,int d)
         System.out.println("\nDistance form "+s+" to "+d+" is : "+dist[d]);
         
     }
+    /**
+     * This api prints the diameter of this WebGraph
+     */
     void diameter()
     {
         int max=Integer.MIN_VALUE;

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,14 @@`
	`1`	`+/**`
	`2`	`+ * This class represents University and contains it's child domain classes(Course, Student, Sem, Department and Institute)`
	`3`	`+ */`
`1`	`4`	`package javacodes;`
`2`	`5`
`3`	`6`	`import java.util.*;`
`4`	`7`
	`8`	`+/**`
	`9`	`+ * This class is to represnt a Student`
	`10`	`+ *`
	`11`	`+ */`
`5`	`12`	`class Students`
`6`	`13`	`{`
`7`	`14`	`String name="";`
`@@ -34,6 +41,11 @@ void getstu()`
`34`	`41`	`System.out.println(name+"\t"+roll+"\t"+cgpa);`
`35`	`42`	`}`
`36`	`43`	`}`
	`44`	`+`
	`45`	`+/**`
	`46`	`+ * This class is to represent a Semester with containing students and other information`
	`47`	`+ *`
	`48`	`+ */`
`37`	`49`	`class Sem`
`38`	`50`	`{`
`39`	`51`	`ArrayList<Students> li;`
`@@ -87,6 +99,10 @@ void showsem()`
`87`	`99`	`}`
`88`	`100`	`}`
`89`	`101`	`}`
	`102`	`+/**`
	`103`	`+ * This class represnts a Course in a Institute`
	`104`	`+ *`
	`105`	`+ */`
`90`	`106`	`class Course`
`91`	`107`	`{`
`92`	`108`	`String name;`
`@@ -136,6 +152,10 @@ void showcourse()`
`136`	`152`	`}`
`137`	`153`	`}`
`138`	`154`	`}`
	`155`	`+/**`
	`156`	`+ * This class represents a Department in a Institute`
	`157`	`+ *`
	`158`	`+ */`
`139`	`159`	`class Department`
`140`	`160`	`{`
`141`	`161`	`String name;`
`@@ -185,6 +205,10 @@ void showdept()`
`185`	`205`	`}`
`186`	`206`	`}`
`187`	`207`	`}`
	`208`	`+/**`
	`209`	`+ * This class represents an Institute`
	`210`	`+ *`
	`211`	`+ */`
`188`	`212`	`class Institute`
`189`	`213`	`{`
`190`	`214`	`String name;`
`@@ -234,6 +258,10 @@ void showinst()`
`234`	`258`	`}`
`235`	`259`	`}`
`236`	`260`	`}`
	`261`	`+/**`
	`262`	`+ * This class represents a University containing one or more Institute`
	`263`	`+ *`
	`264`	`+ */`
`237`	`265`	`public class University {`
`238`	`266`
`239`	`267`	`public static void main(String[] args)`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`package javacodes;`
`2`		`-`
	`2`	`+/**`
	`3`	`+ * This class is to represent a Graph and to perform some operation in Graph`
	`4`	`+ */`
`3`	`5`	`import java.util.*;`
`4`	`6`
`5`	`7`
`@@ -11,6 +13,10 @@ class WebGraph`
`11`	`13`	`private int dist[];`
`12`	`14`	`private int par[];`
`13`	`15`
	`16`	`+ /**`
	`17`	`+ * Constructor to create a WebGraph`
	`18`	`+ * @param v`
	`19`	`+ */`
`14`	`20`	`WebGraph(int v)`
`15`	`21`	`{`
`16`	`22`	`V = v;`
`@@ -27,13 +33,21 @@ class WebGraph`
`27`	`33`	`}`
`28`	`34`	`}`
`29`	`35`
`30`		`-`
	`36`	`+ /**`
	`37`	`+ * This is to add an edge in the WebGraph with Vertices v and Weight w`
	`38`	`+ * @param v`
	`39`	`+ * @param w`
	`40`	`+ */`
`31`	`41`	`void addEdge(int v,int w)`
`32`	`42`	`{`
`33`	`43`	`adj[v].add(w);`
`34`	`44`	`}`
`35`	`45`
`36`	`46`
	`47`	`+ /**`
	`48`	`+ * This api performs Breadth First Search in (this)WebGraph`
	`49`	`+ * @param s`
	`50`	`+ */`
`37`	`51`	`void BFS(int s)`
`38`	`52`	`{`
`39`	`53`
`@@ -80,6 +94,13 @@ void BFS(int s)`
`80`	`94`	`}`
`81`	`95`	`}`
`82`	`96`
	`97`	`+ /**`
	`98`	`+ * Thus api prints a path(showing all the vertices in between s and d`
	`99`	`+ * vertices) from Source vertices s to Destination vertices d`
	`100`	`+ *`
	`101`	`+ * @param s`
	`102`	`+ * @param d`
	`103`	`+ */`
`83`	`104`	`void path(int s,int d)`
`84`	`105`	`{`
`85`	`106`	`BFS(s);`
`@@ -97,6 +118,9 @@ void path(int s,int d)`
`97`	`118`	`System.out.println("\nDistance form "+s+" to "+d+" is : "+dist[d]);`
`98`	`119`
`99`	`120`	`}`
	`121`	`+ /**`
	`122`	`+ * This api prints the diameter of this WebGraph`
	`123`	`+ */`
`100`	`124`	`void diameter()`
`101`	`125`	`{`
`102`	`126`	`int max=Integer.MIN_VALUE;`