Docstring changes and I2C_ADDRESS variable rename

androidthings · Sep 20, 2018 · 58c1bc1 · 58c1bc1
1 parent 4a064fb
commit 58c1bc1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/cap1xxx/src/main/java/com/google/android/things/contrib/driver/cap1xxx/Cap1xxx.java b/cap1xxx/src/main/java/com/google/android/things/contrib/driver/cap1xxx/Cap1xxx.java
@@ -89,7 +89,7 @@ public enum Configuration {
     /**
      * Default I2C slave address for the CAP1xxx family.
      */
-    public static final int I2C_ADDRESS = 0x28;
+    public static final int DEFAULT_I2C_ADDRESS = 0x28;
 
     @Retention(RetentionPolicy.SOURCE)
     @IntDef({REPEAT_DISABLE, REPEAT_FAST, REPEAT_NORMAL, REPEAT_SLOW})
@@ -192,7 +192,7 @@ public Cap1xxx(Context context, String i2cName, String alertName, Configuration
     }
 
     /**
-     * Create a new Cap12xx controller with the default I2C address.
+     * Create a new Cap1xxx controller with the default I2C address.
      *
      * @param i2cName I2C port name where the controller is attached. Cannot be null.
      * @param alertName optional GPIO pin name connected to the controller's
@@ -224,14 +224,14 @@ public Cap1xxx(Context context, String i2cName, String alertName, Configuration
      * @throws IOException
      */
     public Cap1xxx(String i2cName, String alertName, Configuration chip, Handler handler) throws IOException {
-        this(i2cName, I2C_ADDRESS, alertName, chip, handler);
+        this(i2cName, DEFAULT_I2C_ADDRESS, alertName, chip, handler);
     }
 
     /**
      * Create a new Cap1xxx controller.
      *
      * @param i2cName I2C port name where the controller is attached. Cannot be null.
-     * @param i2cAddress 7-bit I2C address for the attached controller. Cannot be null.
+     * @param i2cAddress 7-bit I2C address for the attached controller.
      * @param alertName optional GPIO pin name connected to the controller's
      *                  alert interrupt signal. Can be null.
      * @param chip identifier for the connected controller device chip.

diff --git a/...xx/src/main/java/com/google/android/things/contrib/driver/cap1xxx/Cap1xxxInputDriver.java b/...xx/src/main/java/com/google/android/things/contrib/driver/cap1xxx/Cap1xxxInputDriver.java
@@ -105,7 +105,7 @@ public Cap1xxxInputDriver(String i2cName, String alertName, Configuration chip,
      * framework.
      *
      * @param i2cName I2C port name where the controller is attached. Cannot be null.
-     * @param i2cAddress 7-bit I2C address for the attached controller. Cannot be null.
+     * @param i2cAddress 7-bit I2C address for the attached controller.
      * @param alertName Optional GPIO pin name connected to the controller's alert interrupt signal.
      *                  Can be null.
      * @param chip Identifier for the connected controller device chip.