update javadocs

midhunhk · Jul 26, 2018 · ff84499 · ff84499
1 parent 930c7b8
commit ff84499
Show file tree

Hide file tree

Showing 83 changed files with 322 additions and 224 deletions.
diff --git a/app/src/main/java/com/ae/apps/common/db/CopiedDataBaseHelper.java b/app/src/main/java/com/ae/apps/common/db/CopiedDataBaseHelper.java
@@ -29,10 +29,10 @@ public abstract class CopiedDataBaseHelper extends SQLiteOpenHelper {
 	/**
 	 * Required constructor
 	 * 
-	 * @param context
-	 * @param databaseName
-	 * @param factory
-	 * @param version
+	 * @param context context
+	 * @param databaseName  database name
+	 * @param factory cursor factory
+	 * @param version database version
 	 */
 	public CopiedDataBaseHelper(Context context, String databaseName, CursorFactory factory, int version) {
 		super(context, databaseName, factory, version);
@@ -44,9 +44,8 @@ public CopiedDataBaseHelper(Context context, String databaseName, CursorFactory
 	/**
 	 * Creates the database
 	 * 
-	 * @throws IOException
 	 */
-	public void createDataBase() throws IOException {
+	public void createDataBase() {
 		boolean dbExist = checkDataBase();
 		if (dbExist) {
 			// do nothing - database already exists
@@ -78,12 +77,12 @@ protected boolean checkDataBase() {
 		if (checkDB != null) {
 			checkDB.close();
 		}
-		return checkDB != null ? true : false;
+		return checkDB != null;
 	}
 
 	/**
 	 * Copies your database from your local assets-folder to the just created empty database in the system folder, from
-	 * where it can be accessed and handled. This is done by transfering bytestream.
+	 * where it can be accessed and handled. This is done by transferring byte stream.
 	 * */
 	protected void copyDataBase() throws IOException {
 		// Open your local db as the input stream
@@ -95,7 +94,7 @@ protected void copyDataBase() throws IOException {
 		// Open the empty db as the output stream
 		OutputStream myOutput = new FileOutputStream(outFileName);
 
-		// transfer bytes from the inputfile to the outputfile
+		// transfer bytes from the input file to the output file
 		byte[] buffer = new byte[1024];
 		int length;
 		while ((length = myInput.read(buffer)) > 0) {
@@ -108,24 +107,44 @@ protected void copyDataBase() throws IOException {
 		myInput.close();
 	}
 
+	/**
+	 * Opens the database
+	 *
+	 * @throws SQLException while opening the database
+	 */
 	public void openDataBase() throws SQLException {
 		// Open the database
 		String myPath = databasePath;
 		mDataBase = SQLiteDatabase.openDatabase(myPath, null, SQLiteDatabase.OPEN_READONLY);
 	}
 
+    /**
+     * close the database
+     */
 	@Override
 	public synchronized void close() {
 		if (mDataBase != null)
 			mDataBase.close();
 		super.close();
 	}
 
+    /**
+     * Invoked onCreate
+     *
+     * @param arg0 database
+     */
 	@Override
 	public void onCreate(SQLiteDatabase arg0) {
 
 	}
 
+    /**
+     * called on database upgrade
+     *
+     * @param db database
+     * @param oldVersion oldversion
+     * @param newVersion newversion
+     */
 	@Override
 	public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
 
@@ -134,14 +153,14 @@ public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
 	/**
 	 * Runs a query on the real database
 	 * 
-	 * @param table
-	 * @param columns
-	 * @param selection
-	 * @param selectionArgs
-	 * @param groupBy
-	 * @param having
-	 * @param orderBy
-	 * @return
+	 * @param table table name
+	 * @param columns columns
+	 * @param selection selection
+	 * @param selectionArgs selectionargs
+	 * @param groupBy groupby
+	 * @param having having clause
+	 * @param orderBy orderby
+	 * @return cursor
 	 */
 	protected Cursor query(String table, String[] columns, String selection, String[] selectionArgs, String groupBy,
 			String having, String orderBy) {

diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:10 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:54 EDT 2018 -->
 <title>All Classes (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:10 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:54 EDT 2018 -->
 <title>All Classes (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/com/ae/apps/common/activities/ToolBarBaseActivity.html b/docs/com/ae/apps/common/activities/ToolBarBaseActivity.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:05 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:39 EDT 2018 -->
 <title>ToolBarBaseActivity (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
@@ -384,6 +384,10 @@ <h4>onCreate</h4>
 <h4>setToolbarTitle</h4>
 <pre>protected&nbsp;void&nbsp;setToolbarTitle(java.lang.String&nbsp;title)</pre>
 <div class="block">Sets the toolbartitle</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>title</code> - Title for the toolbar</dd>
+</dl>
 </li>
 </ul>
 <a name="getToolBar--">
@@ -396,6 +400,7 @@ <h4>getToolBar</h4>
 <div class="block">Returns the toolbar instance</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
+<dd>the toolbar instance</dd>
 </dl>
 </li>
 </ul>
@@ -409,6 +414,7 @@ <h4>getToolbarResourceId</h4>
 <div class="block">Returns the toolbar resource id. Should be R.id.toolbar in most cases</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
+<dd>return the toolbar resource id</dd>
 </dl>
 </li>
 </ul>
@@ -422,6 +428,7 @@ <h4>getLayoutResourceId</h4>
 <div class="block">Returns the layout resource id for the activity</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
+<dd>return the layout resource id</dd>
 </dl>
 </li>
 </ul>

diff --git a/docs/com/ae/apps/common/activities/multicontact/MultiContactBaseActivity.html b/docs/com/ae/apps/common/activities/multicontact/MultiContactBaseActivity.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:06 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:41 EDT 2018 -->
 <title>MultiContactBaseActivity (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>

diff --git a/docs/com/ae/apps/common/activities/multicontact/MultiContactPickerConstants.html b/docs/com/ae/apps/common/activities/multicontact/MultiContactPickerConstants.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:06 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:41 EDT 2018 -->
 <title>MultiContactPickerConstants (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>

diff --git a/docs/com/ae/apps/common/activities/multicontact/package-frame.html b/docs/com/ae/apps/common/activities/multicontact/package-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:09 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:53 EDT 2018 -->
 <title>com.ae.apps.common.activities.multicontact (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>

diff --git a/docs/com/ae/apps/common/activities/multicontact/package-summary.html b/docs/com/ae/apps/common/activities/multicontact/package-summary.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:09 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:53 EDT 2018 -->
 <title>com.ae.apps.common.activities.multicontact (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>

diff --git a/docs/com/ae/apps/common/activities/multicontact/package-tree.html b/docs/com/ae/apps/common/activities/multicontact/package-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:09 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:53 EDT 2018 -->
 <title>com.ae.apps.common.activities.multicontact Class Hierarchy (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>

diff --git a/docs/com/ae/apps/common/activities/package-frame.html b/docs/com/ae/apps/common/activities/package-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:09 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:53 EDT 2018 -->
 <title>com.ae.apps.common.activities (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>

diff --git a/docs/com/ae/apps/common/activities/package-summary.html b/docs/com/ae/apps/common/activities/package-summary.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:09 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:53 EDT 2018 -->
 <title>com.ae.apps.common.activities (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>

diff --git a/docs/com/ae/apps/common/activities/package-tree.html b/docs/com/ae/apps/common/activities/package-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_40) on Wed Jul 25 14:08:09 EDT 2018 -->
+<!-- Generated by javadoc (1.8.0_40) on Thu Jul 26 09:27:53 EDT 2018 -->
 <title>com.ae.apps.common.activities Class Hierarchy (LibAeApps 3.0.0)</title>
-<meta name="date" content="2018-07-25">
+<meta name="date" content="2018-07-26">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>