more javadoc comments.

Author: syslogic

README.md

@@ -29,7 +29,7 @@ The JitPack repository URL would be: `maven { url 'https://jitpack.io' }`
 
     dependencies {
         // implementation "io.syslogic:androidx-github:master-SNAPSHOT"
-        implementation "io.syslogic:androidx-github:1.1.7"
+        implementation "io.syslogic:androidx-github:1.1.8"
     }
 
 [![Release](https://jitpack.io/v/syslogic/androidx-github.svg)](https://jitpack.io/#io.syslogic/androidx-github)

library/src/main/java/io/syslogic/github/api/room/LicensesDao.java

@@ -21,26 +21,49 @@
 @Dao
 public interface LicensesDao {
 
+    /** @return a list of {@link License} records. */
     @Query("SELECT * FROM " + Constants.TABLE_LICENSES)
     List<License> getItems();
 
-    /* For ContentProvider */
+    /** @return one {@link License} record. */
+    @Query("SELECT * FROM " + Constants.TABLE_LICENSES + " WHERE id LIKE :itemId LIMIT 1")
+    License getItem(Long itemId);
+
+    /**
+     * For ContentProvider
+     * @return a cursor.
+     */
     @Query("SELECT * FROM " + Constants.TABLE_LICENSES)
     Cursor selectAll();
 
+    /**
+     * @param item the {@link License} to insert.
+     * @return the id of the item inserted.
+     */
     @Insert()
     Long insert(License item);
 
+    /**
+     * @param item the {@link License} to update.
+     */
     @Update()
     void update(License item);
 
+    /**
+     * @param item the {@link License} to delete.
+     */
     @Delete()
     void delete(License item);
 
+    /**
+     * Delete one {@link License} record by ID.
+     * @return the number of affected records.
+     */
     @SuppressWarnings("unused")
     @Query("DELETE FROM " + Constants.TABLE_LICENSES + " WHERE id = :itemId")
-    void deleteById(Long itemId);
+    int deleteById(Long itemId);
 
+    /** Delete all {@link License} records. */
     @Query("DELETE FROM " + Constants.TABLE_LICENSES)
     void clear();
 }

library/src/main/java/io/syslogic/github/api/room/OwnersDao.java

@@ -21,26 +21,49 @@
 @Dao
 public interface OwnersDao {
 
+    /** @return a list of {@link Owner} records. */
     @Query("SELECT * FROM " + Constants.TABLE_OWNERS)
     List<Owner> getItems();
 
-    /* For ContentProvider */
+    /** @return one {@link Owner} record. */
+    @Query("SELECT * FROM " + Constants.TABLE_OWNERS + " WHERE id LIKE :itemId LIMIT 1")
+    Owner getItem(Long itemId);
+
+    /**
+     * For ContentProvider
+     * @return a cursor.
+     */
     @Query("SELECT * FROM " + Constants.TABLE_OWNERS)
     Cursor selectAll();
 
+    /**
+     * @param item the {@link Owner} to insert.
+     * @return the id of the item inserted.
+     */
     @Insert()
     Long insert(Owner item);
 
+    /**
+     * @param item the {@link Owner} to update.
+     */
     @Update()
     void update(Owner item);
 
+    /**
+     * @param item the {@link Owner} to delete.
+     */
     @Delete()
     void delete(Owner item);
 
+    /**
+     * Delete one {@link Owner} record by ID.
+     * @return the number of affected records.
+     */
     @SuppressWarnings("unused")
     @Query("DELETE FROM " + Constants.TABLE_OWNERS + " WHERE id = :itemId")
     void deleteById(Long itemId);
 
+    /** Delete all {@link Owner} records. */
     @Query("DELETE FROM " + Constants.TABLE_OWNERS)
     void clear();
 }

library/src/main/java/io/syslogic/github/api/room/QueryStringsDao.java

@@ -21,29 +21,49 @@
 @Dao
 public interface QueryStringsDao {
 
+    /** @return a list of {@link QueryString} records. */
     @Query("SELECT * FROM " + Constants.TABLE_QUERY_STRINGS)
     List<QueryString> getItems();
 
+    /** @return one {@link QueryString} record. */
     @Query("SELECT * FROM " + Constants.TABLE_QUERY_STRINGS + " WHERE id = :itemId")
     QueryString getItem(Long itemId);
 
-    /* For ContentProvider */
+    /**
+     * For ContentProvider
+     * @return a cursor.
+     */
     @Query("SELECT * FROM " + Constants.TABLE_QUERY_STRINGS)
     Cursor selectAll();
 
+    /**
+     * @param item the {@link QueryString} to insert.
+     * @return the id of the item inserted.
+     */
     @Insert()
     Long insert(QueryString item);
 
+    /**
+     * @param item the {@link QueryString} to update.
+     */
     @Update()
     int update(QueryString item);
 
+    /**
+     * @param item the {@link QueryString} to delete.
+     */
     @Delete()
     void delete(QueryString item);
 
+    /**
+     * Delete one {@link QueryString} record by ID.
+     * @return the number of affected records.
+     */
     @SuppressWarnings("unused")
     @Query("DELETE FROM " + Constants.TABLE_QUERY_STRINGS + " WHERE id = :itemId")
     int deleteById(Long itemId);
 
+    /** Delete all {@link QueryString} records. */
     @Query("DELETE FROM " + Constants.TABLE_QUERY_STRINGS)
     void clear();
 }

library/src/main/java/io/syslogic/github/api/room/RepositoriesDao.java

@@ -21,32 +21,56 @@
 @Dao
 public interface RepositoriesDao {
 
+    /** @return a list of {@link Repository} records. */
     @Query("SELECT * FROM " + Constants.TABLE_REPOSITORIES)
     List<Repository> getItems();
 
-    /* For ContentProvider */
+    /** @return one {@link Repository} record. */
+    @Query("SELECT * FROM " + Constants.TABLE_REPOSITORIES + " WHERE id LIKE :itemId LIMIT 1")
+    Repository getItem(Long itemId);
+
+    /**
+     * For ContentProvider
+     * @return a cursor.
+     */
     @Query("SELECT * FROM " + Constants.TABLE_REPOSITORIES)
     Cursor selectAll();
 
-    /* For ContentProvider */
+    /**
+     * For ContentProvider
+     * @param itemId the id of the record.
+     * @return a cursor.
+     */
     @Query("SELECT * FROM " + Constants.TABLE_REPOSITORIES + " WHERE id LIKE :itemId LIMIT 1")
     Cursor getCursor(Long itemId);
 
-    @Query("SELECT * FROM " + Constants.TABLE_REPOSITORIES + " WHERE id LIKE :itemId LIMIT 1")
-    Repository getItem(Long itemId);
-
+    /**
+     * @param item the {@link Repository} to insert.
+     * @return the id of the item inserted.
+     */
     @Insert()
     Long insert(Repository item);
 
+    /**
+     * @param item the {@link Repository} to update.
+     */
     @Update()
     int update(Repository item);
 
+    /**
+     * @param item the {@link Repository} to delete.
+     */
     @Delete()
     void delete(Repository item);
 
+    /**
+     * Delete one {@link Repository} record by ID.
+     * @return the number of affected records.
+     */
     @Query("DELETE FROM " + Constants.TABLE_REPOSITORIES + " WHERE id = :itemId")
     int deleteById(Long itemId);
 
+    /** Delete all {@link Repository} records. */
     @Query("DELETE FROM " + Constants.TABLE_REPOSITORIES)
     void clear();
 }

library/src/main/java/io/syslogic/github/api/room/WorkflowsDao.java

@@ -21,33 +21,57 @@
 @Dao
 public interface WorkflowsDao {
 
+    /** @return a list of {@link Workflow} records. */
     @Query("SELECT * FROM " + Constants.TABLE_WORKFLOWS)
     List<Workflow> getItems();
 
-    /* For ContentProvider */
+    /** @return one {@link Workflow} record. */
+    @Query("SELECT * FROM " + Constants.TABLE_WORKFLOWS + " WHERE id LIKE :itemId LIMIT 1")
+    Workflow getItem(Long itemId);
+
+    /**
+     * For ContentProvider
+     * @return a cursor.
+     */
     @Query("SELECT * FROM " + Constants.TABLE_WORKFLOWS)
     Cursor selectAll();
 
-    /* For ContentProvider */
+    /**
+     * For ContentProvider
+     * @param itemId the id of the record.
+     * @return a cursor.
+     */
     @Query("SELECT * FROM " + Constants.TABLE_WORKFLOWS + " WHERE id LIKE :itemId LIMIT 1")
     Cursor getCursor(Long itemId);
 
-    @Query("SELECT * FROM " + Constants.TABLE_WORKFLOWS + " WHERE id LIKE :itemId LIMIT 1")
-    Workflow getItem(Long itemId);
-
+    /**
+     * @param item the {@link Workflow} to insert.
+     * @return the id of the item inserted.
+     */
     @Insert()
     Long insert(Workflow item);
 
+    /**
+     * @param item the {@link Workflow} to update.
+     */
     @Update()
     int update(Workflow item);
 
+    /**
+     * @param item the {@link Workflow} to delete.
+     */
     @Delete()
     void delete(Workflow item);
 
+    /**
+     * Delete one {@link Workflow} record by ID.
+     * @return the number of affected records.
+     */
     @SuppressWarnings("unused")
     @Query("DELETE FROM " + Constants.TABLE_WORKFLOWS + " WHERE id = :itemId")
     int deleteById(Long itemId);
 
+    /** Delete all {@link Workflow} records. */
     @Query("DELETE FROM " + Constants.TABLE_WORKFLOWS)
     void clear();
 }