generate javadoc jar when building

Author: mateusz-bajorek

pom.xml

@@ -67,6 +67,7 @@
         <maven-compiler-plugin.version>3.6.1</maven-compiler-plugin.version>
         <maven-source-plugin.version>3.0.1</maven-source-plugin.version>
         <maven-resources-plugin.version>3.0.2</maven-resources-plugin.version>
+        <maven-javadoc-plugin.version>2.10.4</maven-javadoc-plugin.version>
         <animal-sniffer-maven-plugin.version>1.15</animal-sniffer-maven-plugin.version>
         <maven-install-plugin.version>2.5.2</maven-install-plugin.version>
         <maven-jar-plugin.version>3.0.2</maven-jar-plugin.version>
@@ -290,6 +291,7 @@
                 </plugin>
             </plugins>
         </pluginManagement>
+
         <plugins>
             <plugin>
                 <artifactId>maven-compiler-plugin</artifactId>
@@ -329,6 +331,24 @@
                 </configuration>
             </plugin>
 
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>${maven-javadoc-plugin.version}</version>
+                <configuration>
+                    <show>private</show>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>attach-javadoc</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                        <phase>package</phase>
+                    </execution>
+                </executions>
+            </plugin>
+
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>animal-sniffer-maven-plugin</artifactId>

src/main/java/com/currencyfair/onesignal/OneSignal.java

@@ -63,7 +63,7 @@ private OneSignal() {
      * If a targeting parameter of one type is used, then targeting parameters from other types may not be used.
      * For instance, you cannot use the {@link NotificationRequest#includedSegments} parameter (from segments) with
      * the {@link NotificationRequest#filters}.
-     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
+     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
      * @param notificationRequest the notification to create
      * @return the response
      */
@@ -73,7 +73,7 @@ public static CreateNotificationResponse createNotification(String appAuthKey, N
 
     /**
      * Stop a scheduled or currently outgoing notification.
-     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs, unless the notification was created using
+     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs, unless the notification was created using
      * {@link NotificationRequest#includePlayerIds} and targeting only one user.
      * @param appId OneSignal App ID
      * @param notificationId the notification ID to cancel
@@ -84,7 +84,7 @@ public static void cancelNotification(String appAuthKey, String appId, String no
 
     /**
      * View the details of a single notification.
-     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
+     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
      * @param appId OneSignal App ID
      * @param notificationId the notification ID to retrieve
      * @return the matching notifications or error response
@@ -95,7 +95,7 @@ public static ViewNotificationResponse viewNotification(String appAuthKey, Strin
 
     /**
      * View the details of multiple notifications.
-     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
+     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
      * @param appId OneSignal App ID
      * @param limit max number of notifications to retrieve, if {@code null} defaults to {@code 50}
      * @param offset where to start, if {@code null} defaults to {@code 0}
@@ -116,7 +116,7 @@ public static void trackOpen(String appId, String notificationId) {
 
     /**
      * View the details of all of your current OneSignal apps.
-     * @param userAuthKey OneSignal User Auth Key, available in Keys & IDs.
+     * @param userAuthKey OneSignal User Auth Key, available in Keys & IDs.
      * @return list of all your apps
      */
     public static List<AppResponse> viewApps(String userAuthKey) {
@@ -125,7 +125,7 @@ public static List<AppResponse> viewApps(String userAuthKey) {
 
     /**
      * View the details of a single OneSignal app.
-     * @param userAuthKey OneSignal User Auth Key, available in Keys & IDs.
+     * @param userAuthKey OneSignal User Auth Key, available in Keys &amp; IDs.
      * @param appId the app ID
      * @return the details of the app
      */
@@ -135,7 +135,7 @@ public static AppResponse viewApp(String userAuthKey, String appId) {
 
     /**
      * Creates a new OneSignal app.
-     * @param userAuthKey OneSignal User Auth Key, available in Keys & IDs.
+     * @param userAuthKey OneSignal User Auth Key, available in Keys &amp; IDs.
      * @param app the app details for creation
      * @return the created app
      */
@@ -150,15 +150,15 @@ public static AppResponse createApp(String userAuthKey, App app) {
      * <ul>
      * <li>To update only your app name, you can pass in only a new app name parameter.</li>
      * <li>To update Android, be sure to pass in {@link App#gcmKey}.</li>
-     * <li>To update Chrome Apps & Extensions, be sure to pass in {@link App#chromeKey}.</li>
+     * <li>To update Chrome Apps &amp; Extensions, be sure to pass in {@link App#chromeKey}.</li>
      * <li>To update Chrome web push, be sure to pass in {@link App#chromeWebOrigin}.</li>
      * <li>To update Safari web push, you must pass in all of these parameters: {@link App#safariApnsP12},
      * {@link App#safariApnsP12password}, {@link App#siteName}, and {@link App#safariSiteOrigin}. Most users use our
      * auto-generated Safari web ID. If you use our auto-generated Safari web ID, please set {@link App#safariApnsP12}
      * to {@code ""} and {@link App#safariApnsP12password} to {@code ""}.</li>
      * <li>To update iOS, you must pass in {@link App#apnsEnv} and {@link App#apnsP12}.</li>
      * </ul>
-     * @param userAuthKey OneSignal User Auth Key, available in Keys & IDs.</li>
+     * @param userAuthKey OneSignal User Auth Key, available in Keys &amp; IDs.
      * @param app the app details for update
      * @return the updated app
      */
@@ -169,11 +169,11 @@ public static AppResponse updateApp(String userAuthKey, App app) {
     /**
      * View the details of multiple devices in one of your OneSignal apps.
      * <p>
-     * <b>Unavailable for Apps > 100,000 users</b>
+     * <b>Unavailable for Apps &gt; 100,000 users</b>
      * <p>
      * For performance reasons, this method is not available for larger apps. Larger apps should use the CSV export API
      * endpoint, which is much more performant.
-     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
+     * @param appAuthKey OneSignal App Auth Key, available in Keys &amp; IDs.
      * @param appId The app ID that you want to view devices from
      * @param limit How many devices to return. Max is 300. Default is 300
      * @param offset Result offset. Default is 0. Results are sorted by id
@@ -185,7 +185,7 @@ public static ViewDevicesResponse viewDevices(String appAuthKey, String appId, N
 
     /**
      * View the details of an existing device in one of your OneSignal apps
-     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
+     * @param appAuthKey OneSignal App Auth Key, available in Keys &amp; IDs.
      * @param appId Your app_id for this device
      * @param deviceId Player's OneSignal ID
      * @return details of the given device
@@ -284,7 +284,7 @@ public static SuccessResponse incrementSessionLength(String deviceId, Long activ
      * The file will be compressed using GZip.
      * <p>
      * The file may take several minutes to generate depending on the number of users in your app.
-     * @param appAuthKey OneSignal App Auth Key, available in Keys & IDs.
+     * @param appAuthKey OneSignal App Auth Key, available in Keys &amp; IDs.
      * @param appId OneSignal App ID
      * @param csvExportFileLocationRequest the optional request object
      * @return object with the url to the CSV file

src/main/java/com/currencyfair/onesignal/model/notification/Notification.java

@@ -95,7 +95,7 @@ public class Notification {
     // The following are parameters in Create Notifications common to all methods of targeting users.
 
     /**
-     * REQUIRED Your OneSignal application ID, which can be found in Keys & IDs. It is a UUID and looks similar to
+     * REQUIRED Your OneSignal application ID, which can be found in Keys & IDs. It is a UUID and looks similar to
      * {@code 8250eaf6-1a58-489e-b136-7c74a864b434}.
      */
     @JsonProperty("app_id")
@@ -487,7 +487,7 @@ public class Notification {
     /**
      * Schedule notification for future delivery.
      * <p>
-     * Examples: All examples are the exact same date & time.
+     * Examples: All examples are the exact same date &amp; time.
      * <p>
      * {@code "Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)"}
      * <p>
@@ -622,7 +622,7 @@ public class Notification {
 
     /**
      * Indicates whether to send to all Google Chrome, Chrome on Android, and Mozilla Firefox users registered under
-     * your Chrome & Firefox web push platform.
+     * your Chrome &amp; Firefox web push platform.
      * <p>
      * WEB
      */
@@ -672,9 +672,9 @@ public class Notification {
 
     /**
      * THIS FLAG IS NOT USED FOR WEB PUSH Please see {@link #chromeWeb} for sending to web push users. This flag only
-     * applies to Google Chrome Apps & Extensions.
+     * applies to Google Chrome Apps &amp; Extensions.
      * <p>
-     * Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.
+     * Indicates whether to send to all devices registered under your app's Google Chrome Apps &amp; Extension platform.
      * <p>
      * CHROMEAPP
      */

src/main/java/com/currencyfair/onesignal/model/player/AddEditDeviceRequest.java

@@ -27,7 +27,7 @@
 public class AddEditDeviceRequest extends Device {
 
     /**
-     * REQUIRED Your OneSignal App Id found in Keys & IDs.
+     * REQUIRED Your OneSignal App Id found in Keys & IDs.
      */
     @JsonProperty("app_id")
     private String appId;