Skip to content

Commit 96c4d17

Browse files
philips77philips77
committed
Comments and JavaDoc. New build tools.
1 parent 477f16e commit 96c4d17

File tree

94 files changed

+5463
-3223
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+5463
-3223
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
The compat library may be found on jcenter and Maven Central repository. Add it to your project by adding the following dependency:
88

99
```Groovy
10-
compile 'no.nordicsemi.android:dfu:0.6.2'
10+
compile 'no.nordicsemi.android:dfu:0.6.3'
1111
```
1212

1313
If you use proguard, add the following line to your proguard rules:

‎build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ buildscript {
55
jcenter()
66
}
77
dependencies {
8-
classpath 'com.android.tools.build:gradle:1.5.0'
8+
classpath 'com.android.tools.build:gradle:2.1.2'
99
/*
10-
classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2"
10+
classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7"
1111
// The following dependency has been replaced with newer version according to https://github.com/dcendents/android-maven-plugin
1212
// classpath 'com.github.dcendents:android-maven-plugin:1.2'
1313
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
@@ -21,4 +21,4 @@ allprojects {
2121
repositories {
2222
jcenter()
2323
}
24-
}
24+
}

‎dfu/build.gradle

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ apply plugin: 'com.jfrog.bintray'
1515
ext {
1616
PUBLISH_GROUP_ID = 'no.nordicsemi.android'
1717
PUBLISH_ARTIFACT_ID = 'dfu'
18-
PUBLISH_VERSION = '0.6.2'
18+
PUBLISH_VERSION = '0.6.3'
1919
2020
bintrayRepo = 'android'
2121
bintrayName = 'dfu-library'
@@ -105,4 +105,12 @@ bintray {
105105
}
106106
}
107107
}
108-
}*/
108+
}
109+
110+
if (JavaVersion.current().isJava8Compatible()) {
111+
allprojects {
112+
tasks.withType(Javadoc) {
113+
options.addStringOption('Xdoclint:none', '-quiet')
114+
}
115+
}
116+
}*/

‎dfu/src/main/java/no/nordicsemi/android/dfu/DfuBaseService.java

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
* </p>
8181
* <p>
8282
* The {@link DfuServiceInitiator} object should be used to start the DFU Service.
83-
* <p/>
83+
* </p>
8484
* <pre>
8585
* final DfuServiceInitiator starter = new DfuServiceInitiator(mSelectedDevice.getAddress())
8686
* .setDeviceName(mSelectedDevice.getName())
@@ -278,7 +278,7 @@ public abstract class DfuBaseService extends IntentService {
278278
* <li>An error code with {@link #ERROR_REMOTE_MASK} if remote DFU target returned an error</li>
279279
* <li>An error code with {@link #ERROR_CONNECTION_MASK} if connection error occurred (f.e. GATT error (133) or Internal GATT Error (129))</li>
280280
* </ul>
281-
* To check if error occurred use:<br />
281+
* To check if error occurred use:<br>
282282
* {@code boolean error = progressValue >= DfuBaseService.ERROR_MASK;}
283283
*/
284284
public static final String EXTRA_PROGRESS = "no.nordicsemi.android.dfu.extra.EXTRA_PROGRESS";
@@ -442,7 +442,7 @@ public abstract class DfuBaseService extends IntentService {
442442
* <ul>
443443
* <li>{@link #EXTRA_LOG_LEVEL} - The log level, one of following: {@link #LOG_LEVEL_DEBUG}, {@link #LOG_LEVEL_VERBOSE}, {@link #LOG_LEVEL_INFO},
444444
* {@link #LOG_LEVEL_APPLICATION}, {@link #LOG_LEVEL_WARNING}, {@link #LOG_LEVEL_ERROR}</li>
445-
* <li>{@link #EXTRA_LOG_MESSAGE}</li> - The log message
445+
* <li>{@link #EXTRA_LOG_MESSAGE} - The log message</li>
446446
* </ul>
447447
*/
448448
public static final String BROADCAST_LOG = "no.nordicsemi.android.dfu.broadcast.BROADCAST_LOG";
@@ -2920,10 +2920,9 @@ private void updateProgressNotification(final int progress) {
29202920
* <ul>
29212921
* <li>{@link #EXTRA_DEVICE_ADDRESS} - target device address</li>
29222922
* <li>{@link #EXTRA_DEVICE_NAME} - target device name</li>
2923-
* <li>{@link #EXTRA_PROGRESS} - the connection state (values < 0)*, current progress (0-100) or error number if {@link #ERROR_MASK} bit set.</li>
2923+
* <li>{@link #EXTRA_PROGRESS} - the connection state (values &lt; 0)*, current progress (0-100) or error number if {@link #ERROR_MASK} bit set.</li>
29242924
* </ul>
2925-
* <p>
2926-
* __________<br />
2925+
* _______________________________<br>
29272926
* * - connection state constants:
29282927
* <ul>
29292928
* <li>{@link #PROGRESS_CONNECTING}</li>
@@ -2934,7 +2933,6 @@ private void updateProgressNotification(final int progress) {
29342933
* <li>{@link #PROGRESS_ENABLING_DFU_MODE}</li>
29352934
* <li>{@link #PROGRESS_VALIDATING}</li>
29362935
* </ul>
2937-
* </p>
29382936
*
29392937
* @return the target activity class
29402938
*/

‎dfu/src/main/java/no/nordicsemi/android/dfu/DfuServiceInitiator.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,7 @@ public DfuServiceInitiator setInitFile(final int initFileResId) {
238238
* Sets the URI or path to the Init file. The init file for DFU Bootloader version pre-0.5 (SDK 4.3, 6.0, 6.1) contains only the CRC-16 of the firmware.
239239
* Bootloader version 0.5 or newer requires the Extended Init Packet. If the URI and path are not null the URI will be used.
240240
* @param initFileUri the URI of the init file
241+
* @param initFilePath the path of the init file
241242
* @return the builder
242243
*/
243244
@Deprecated

‎dfu/src/main/java/no/nordicsemi/android/dfu/internal/ArchiveInputStream.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,16 +82,14 @@ public class ArchiveInputStream extends ZipInputStream {
8282
* the ZIP file contains all 3 HEX/BIN files.
8383
* When types is equal to {@link DfuBaseService#TYPE_AUTO} all present files are read.
8484
* </p>
85-
* <p>
86-
* Use bit combination of the following types:
85+
* <p>Use bit combination of the following types:</p>
8786
* <ul>
8887
* <li>{@link DfuBaseService#TYPE_SOFT_DEVICE}</li>
8988
* <li>{@link DfuBaseService#TYPE_BOOTLOADER}</li>
9089
* <li>{@link DfuBaseService#TYPE_APPLICATION}</li>
9190
* <li>{@link DfuBaseService#TYPE_AUTO}</li>
9291
* </ul>
93-
* </p>
94-
*
92+
*
9593
* @param stream
9694
* the Zip Input Stream
9795
* @param mbrSize

‎dfu/src/main/java/no/nordicsemi/android/dfu/internal/HexInputStream.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,8 @@ public int available() {
156156

157157
/**
158158
* Fills the buffer with next bytes from the stream.
159-
*
159+
*
160+
* @param buffer buffer to be filled
160161
* @return the size of the buffer
161162
* @throws java.io.IOException
162163
*/

‎dfu/src/main/java/no/nordicsemi/android/dfu/internal/scanner/BootloaderScanner.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ public interface BootloaderScanner {
3737
/**
3838
* After the buttonless jump from the application mode to the bootloader mode the service will wait this long for the advertising bootloader (in milliseconds).
3939
*/
40-
public final static long TIMEOUT = 5000l; // ms
41-
/** The bootloader may advertise with the same address or one with the last byte incremented by this value. F.e. 00:11:22:33:44:55 -> 00:11:22:33:44:56. FF changes to 00. */
42-
public final static int ADDRESS_DIFF = 1;
40+
long TIMEOUT = 5000l; // ms
41+
/** The bootloader may advertise with the same address or one with the last byte incremented by this value. F.e. 00:11:22:33:44:55 -&gt; 00:11:22:33:44:56. FF changes to 00. */
42+
int ADDRESS_DIFF = 1;
4343

4444
/**
4545
* Searches for the advertising bootloader. The bootloader may advertise with the same device address or one with the last byte incremented by 1.
@@ -48,7 +48,7 @@ public interface BootloaderScanner {
4848
*
4949
* @param deviceAddress
5050
* the application device address
51-
* @return the address of the advertising DFU bootloader. If may be the same as the application address or one with the last byte incremented by 1 (AA:BB:CC:DD:EE:45/FF -> AA:BB:CC:DD:EE:46/00).
51+
* @return the address of the advertising DFU bootloader. If may be the same as the application address or one with the last byte incremented by 1 (AA:BB:CC:DD:EE:45/FF -&gt; AA:BB:CC:DD:EE:46/00).
5252
*/
53-
public String searchFor(final String deviceAddress);
53+
String searchFor(final String deviceAddress);
5454
}

‎documentation/javadoc/allclasses-frame.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,32 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_65) on Wed Jul 22 14:42:28 CEST 2015 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Thu Jun 30 16:24:38 CEST 2016 -->
66
<title>All Classes</title>
7-
<meta name="date" content="2015-07-22">
7+
<meta name="date" content="2016-06-30">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9+
<script type="text/javascript" src="script.js"></script>
910
</head>
1011
<body>
11-
<h1 class="bar">All Classes</h1>
12+
<h1 class="bar">All&nbsp;Classes</h1>
1213
<div class="indexContainer">
1314
<ul>
15+
<li><a href="no/nordicsemi/android/dfu/ApplicationTest.html" title="class in no.nordicsemi.android.dfu" target="classFrame">ApplicationTest</a></li>
1416
<li><a href="no/nordicsemi/android/dfu/internal/ArchiveInputStream.html" title="class in no.nordicsemi.android.dfu.internal" target="classFrame">ArchiveInputStream</a></li>
15-
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScanner.html" title="interface in no.nordicsemi.android.dfu.internal.scanner" target="classFrame"><i>BootloaderScanner</i></a></li>
17+
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScanner.html" title="interface in no.nordicsemi.android.dfu.internal.scanner" target="classFrame"><span class="interfaceName">BootloaderScanner</span></a></li>
1618
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScannerFactory.html" title="class in no.nordicsemi.android.dfu.internal.scanner" target="classFrame">BootloaderScannerFactory</a></li>
1719
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScannerJB.html" title="class in no.nordicsemi.android.dfu.internal.scanner" target="classFrame">BootloaderScannerJB</a></li>
1820
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScannerLollipop.html" title="class in no.nordicsemi.android.dfu.internal.scanner" target="classFrame">BootloaderScannerLollipop</a></li>
1921
<li><a href="no/nordicsemi/android/dfu/BuildConfig.html" title="class in no.nordicsemi.android.dfu" target="classFrame">BuildConfig</a></li>
2022
<li><a href="no/nordicsemi/android/dfu/internal/exception/DeviceDisconnectedException.html" title="class in no.nordicsemi.android.dfu.internal.exception" target="classFrame">DeviceDisconnectedException</a></li>
2123
<li><a href="no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu" target="classFrame">DfuBaseService</a></li>
2224
<li><a href="no/nordicsemi/android/dfu/internal/exception/DfuException.html" title="class in no.nordicsemi.android.dfu.internal.exception" target="classFrame">DfuException</a></li>
23-
<li><a href="no/nordicsemi/android/dfu/DfuLogListener.html" title="interface in no.nordicsemi.android.dfu" target="classFrame"><i>DfuLogListener</i></a></li>
24-
<li><a href="no/nordicsemi/android/dfu/DfuProgressListener.html" title="interface in no.nordicsemi.android.dfu" target="classFrame"><i>DfuProgressListener</i></a></li>
25+
<li><a href="no/nordicsemi/android/dfu/DfuLogListener.html" title="interface in no.nordicsemi.android.dfu" target="classFrame"><span class="interfaceName">DfuLogListener</span></a></li>
26+
<li><a href="no/nordicsemi/android/dfu/DfuProgressListener.html" title="interface in no.nordicsemi.android.dfu" target="classFrame"><span class="interfaceName">DfuProgressListener</span></a></li>
2527
<li><a href="no/nordicsemi/android/dfu/DfuProgressListenerAdapter.html" title="class in no.nordicsemi.android.dfu" target="classFrame">DfuProgressListenerAdapter</a></li>
2628
<li><a href="no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu" target="classFrame">DfuServiceInitiator</a></li>
2729
<li><a href="no/nordicsemi/android/dfu/DfuServiceListenerHelper.html" title="class in no.nordicsemi.android.dfu" target="classFrame">DfuServiceListenerHelper</a></li>
28-
<li><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu" target="classFrame"><i>DfuSettingsConstants</i></a></li>
30+
<li><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu" target="classFrame"><span class="interfaceName">DfuSettingsConstants</span></a></li>
2931
<li><a href="no/nordicsemi/android/dfu/internal/manifest/FileInfo.html" title="class in no.nordicsemi.android.dfu.internal.manifest" target="classFrame">FileInfo</a></li>
3032
<li><a href="no/nordicsemi/android/error/GattError.html" title="class in no.nordicsemi.android.error" target="classFrame">GattError</a></li>
3133
<li><a href="no/nordicsemi/android/dfu/internal/exception/HexFileValidationException.html" title="class in no.nordicsemi.android.dfu.internal.exception" target="classFrame">HexFileValidationException</a></li>
@@ -38,6 +40,7 @@ <h1 class="bar">All Classes</h1>
3840
<li><a href="no/nordicsemi/android/dfu/R.drawable.html" title="class in no.nordicsemi.android.dfu" target="classFrame">R.drawable</a></li>
3941
<li><a href="no/nordicsemi/android/dfu/R.string.html" title="class in no.nordicsemi.android.dfu" target="classFrame">R.string</a></li>
4042
<li><a href="no/nordicsemi/android/dfu/internal/exception/RemoteDfuException.html" title="class in no.nordicsemi.android.dfu.internal.exception" target="classFrame">RemoteDfuException</a></li>
43+
<li><a href="no/nordicsemi/android/dfu/internal/exception/SizeValidationException.html" title="class in no.nordicsemi.android.dfu.internal.exception" target="classFrame">SizeValidationException</a></li>
4144
<li><a href="no/nordicsemi/android/dfu/internal/manifest/SoftDeviceBootloaderFileInfo.html" title="class in no.nordicsemi.android.dfu.internal.manifest" target="classFrame">SoftDeviceBootloaderFileInfo</a></li>
4245
<li><a href="no/nordicsemi/android/dfu/internal/exception/UnknownResponseException.html" title="class in no.nordicsemi.android.dfu.internal.exception" target="classFrame">UnknownResponseException</a></li>
4346
<li><a href="no/nordicsemi/android/dfu/internal/exception/UploadAbortedException.html" title="class in no.nordicsemi.android.dfu.internal.exception" target="classFrame">UploadAbortedException</a></li>

‎documentation/javadoc/allclasses-noframe.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,32 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_65) on Wed Jul 22 14:42:28 CEST 2015 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Thu Jun 30 16:24:38 CEST 2016 -->
66
<title>All Classes</title>
7-
<meta name="date" content="2015-07-22">
7+
<meta name="date" content="2016-06-30">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9+
<script type="text/javascript" src="script.js"></script>
910
</head>
1011
<body>
11-
<h1 class="bar">All Classes</h1>
12+
<h1 class="bar">All&nbsp;Classes</h1>
1213
<div class="indexContainer">
1314
<ul>
15+
<li><a href="no/nordicsemi/android/dfu/ApplicationTest.html" title="class in no.nordicsemi.android.dfu">ApplicationTest</a></li>
1416
<li><a href="no/nordicsemi/android/dfu/internal/ArchiveInputStream.html" title="class in no.nordicsemi.android.dfu.internal">ArchiveInputStream</a></li>
15-
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScanner.html" title="interface in no.nordicsemi.android.dfu.internal.scanner"><i>BootloaderScanner</i></a></li>
17+
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScanner.html" title="interface in no.nordicsemi.android.dfu.internal.scanner"><span class="interfaceName">BootloaderScanner</span></a></li>
1618
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScannerFactory.html" title="class in no.nordicsemi.android.dfu.internal.scanner">BootloaderScannerFactory</a></li>
1719
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScannerJB.html" title="class in no.nordicsemi.android.dfu.internal.scanner">BootloaderScannerJB</a></li>
1820
<li><a href="no/nordicsemi/android/dfu/internal/scanner/BootloaderScannerLollipop.html" title="class in no.nordicsemi.android.dfu.internal.scanner">BootloaderScannerLollipop</a></li>
1921
<li><a href="no/nordicsemi/android/dfu/BuildConfig.html" title="class in no.nordicsemi.android.dfu">BuildConfig</a></li>
2022
<li><a href="no/nordicsemi/android/dfu/internal/exception/DeviceDisconnectedException.html" title="class in no.nordicsemi.android.dfu.internal.exception">DeviceDisconnectedException</a></li>
2123
<li><a href="no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a></li>
2224
<li><a href="no/nordicsemi/android/dfu/internal/exception/DfuException.html" title="class in no.nordicsemi.android.dfu.internal.exception">DfuException</a></li>
23-
<li><a href="no/nordicsemi/android/dfu/DfuLogListener.html" title="interface in no.nordicsemi.android.dfu"><i>DfuLogListener</i></a></li>
24-
<li><a href="no/nordicsemi/android/dfu/DfuProgressListener.html" title="interface in no.nordicsemi.android.dfu"><i>DfuProgressListener</i></a></li>
25+
<li><a href="no/nordicsemi/android/dfu/DfuLogListener.html" title="interface in no.nordicsemi.android.dfu"><span class="interfaceName">DfuLogListener</span></a></li>
26+
<li><a href="no/nordicsemi/android/dfu/DfuProgressListener.html" title="interface in no.nordicsemi.android.dfu"><span class="interfaceName">DfuProgressListener</span></a></li>
2527
<li><a href="no/nordicsemi/android/dfu/DfuProgressListenerAdapter.html" title="class in no.nordicsemi.android.dfu">DfuProgressListenerAdapter</a></li>
2628
<li><a href="no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></li>
2729
<li><a href="no/nordicsemi/android/dfu/DfuServiceListenerHelper.html" title="class in no.nordicsemi.android.dfu">DfuServiceListenerHelper</a></li>
28-
<li><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu"><i>DfuSettingsConstants</i></a></li>
30+
<li><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu"><span class="interfaceName">DfuSettingsConstants</span></a></li>
2931
<li><a href="no/nordicsemi/android/dfu/internal/manifest/FileInfo.html" title="class in no.nordicsemi.android.dfu.internal.manifest">FileInfo</a></li>
3032
<li><a href="no/nordicsemi/android/error/GattError.html" title="class in no.nordicsemi.android.error">GattError</a></li>
3133
<li><a href="no/nordicsemi/android/dfu/internal/exception/HexFileValidationException.html" title="class in no.nordicsemi.android.dfu.internal.exception">HexFileValidationException</a></li>
@@ -38,6 +40,7 @@ <h1 class="bar">All Classes</h1>
3840
<li><a href="no/nordicsemi/android/dfu/R.drawable.html" title="class in no.nordicsemi.android.dfu">R.drawable</a></li>
3941
<li><a href="no/nordicsemi/android/dfu/R.string.html" title="class in no.nordicsemi.android.dfu">R.string</a></li>
4042
<li><a href="no/nordicsemi/android/dfu/internal/exception/RemoteDfuException.html" title="class in no.nordicsemi.android.dfu.internal.exception">RemoteDfuException</a></li>
43+
<li><a href="no/nordicsemi/android/dfu/internal/exception/SizeValidationException.html" title="class in no.nordicsemi.android.dfu.internal.exception">SizeValidationException</a></li>
4144
<li><a href="no/nordicsemi/android/dfu/internal/manifest/SoftDeviceBootloaderFileInfo.html" title="class in no.nordicsemi.android.dfu.internal.manifest">SoftDeviceBootloaderFileInfo</a></li>
4245
<li><a href="no/nordicsemi/android/dfu/internal/exception/UnknownResponseException.html" title="class in no.nordicsemi.android.dfu.internal.exception">UnknownResponseException</a></li>
4346
<li><a href="no/nordicsemi/android/dfu/internal/exception/UploadAbortedException.html" title="class in no.nordicsemi.android.dfu.internal.exception">UploadAbortedException</a></li>

0 commit comments

Comments
 (0)