General fixes (#104)

* Added IDE specific files to .gitignore
* Fixed javadocs warnings

Author: Thomas Crombez

.gitignore

@@ -14,3 +14,5 @@ bin/
 # custom
 /javadoc/**
 /2.*/**
+.idea/
+*.iml

pom.xml

@@ -114,6 +114,7 @@
 						<verbose>true</verbose>
 						<reportOutputDirectory>${javadoc.output.path}</reportOutputDirectory>
 						<destDir>${project.version}</destDir>
+						<additionalOptions>--allow-script-in-comments</additionalOptions>
 					</configuration>
 				</plugin>
 				<plugin>

src/main/java/com/myjeeva/digitalocean/DigitalOcean.java

@@ -178,6 +178,7 @@ Snapshots getDropletSnapshots(Integer dropletId, Integer pageNo, Integer perPage
    * 
    * @param dropletId for backup info
    * @param pageNo for pagination
+   * @param perPage no. of items per page
    * @return {@link Backups}
    * @throws DigitalOceanException if request had interruption [
    *         <code>HTTP status code &gt;= 400 &amp;&amp; &lt; 510</code>]
@@ -1449,7 +1450,7 @@ Volumes getVolumeInfo(String volumeName, String regionSlug)
   /**
    * Method deletes volume by name and region slug
    * 
-   * @param volumeName
+   * @param volumeName name of the volume
    * @param regionSlug is code name of the region aka DigitalOcean data centers
    * @return {@link Delete}
    * @throws DigitalOceanException if request had interruption [
@@ -1468,8 +1469,9 @@ Delete deleteVolume(String volumeName, String regionSlug)
    * @param volumeId volume identifier
    * @param regionSlug is code name of the region aka DigitalOcean data centers
    * @return {@link Action}
-   * @throws DigitalOceanException
-   * @throws RequestUnsuccessfulException
+   * @throws DigitalOceanException if request had interruption [
+   *         <code>HTTP status code &gt;= 400 &amp;&amp; &lt; 510</code>]
+   * @throws RequestUnsuccessfulException if any RESTful request unsuccessful from wrapper method
    */
   Action attachVolume(Integer dropletId, String volumeId, String regionSlug)
       throws DigitalOceanException, RequestUnsuccessfulException;
@@ -1478,7 +1480,7 @@ Action attachVolume(Integer dropletId, String volumeId, String regionSlug)
    * Method attaches the given volume into droplet by name
    * 
    * @param dropletId droplet identifier
-   * @param volumeName
+   * @param volumeName name of the volume
    * @param regionSlug is code name of the region aka DigitalOcean data centers
    * @return {@link Action}
    * @throws DigitalOceanException if request had interruption [
@@ -1510,7 +1512,7 @@ Action detachVolume(Integer dropletId, String volumeId, String regionSlug)
    * Method detaches volume from the droplet by volume name
    * 
    * @param dropletId droplet identifier
-   * @param volumeName
+   * @param volumeName name of the volume
    * @param regionSlug is code name of the region aka DigitalOcean data centers
    * @return {@link Action}
    * @throws DigitalOceanException if request had interruption [
@@ -1553,10 +1555,10 @@ Actions getAvailableVolumeActions(String volumeId)
       throws DigitalOceanException, RequestUnsuccessfulException;
 
   /**
-   * Method returns specific volume action by action & volume identifier
+   * Method returns specific volume action by action and volume identifier
    * 
-   * @param volumeId
-   * @param actionId
+   * @param volumeId volume identifier
+   * @param actionId the id of action
    * @return {@link Action}
    * @throws DigitalOceanException if request had interruption [
    *         <code>HTTP status code &gt;= 400 &amp;&amp; &lt; 510</code>]
@@ -1570,7 +1572,7 @@ Action getVolumeAction(String volumeId, Integer actionId)
   /**
    * Method return all of the snapshots for given volume Id
    * 
-   * @param volumeId
+   * @param volumeId volume identifier
    * @param pageNo for pagination
    * @param perPage no. of items per page
    * @return {@link Snapshots}
@@ -1586,8 +1588,8 @@ Snapshots getVolumeSnapshots(String volumeId, Integer pageNo, Integer perPage)
   /**
    * Method take snapshot of given volume Id
    * 
-   * @param volumeId
-   * @param snapshotName
+   * @param volumeId volume identifier
+   * @param snapshotName the name the snapshot to be created
    * @return {@link Snapshot}
    * @throws DigitalOceanException if request had interruption [
    *         <code>HTTP status code &gt;= 400 &amp;&amp; &lt; 510</code>]
@@ -1650,7 +1652,7 @@ Snapshots getAllVolumeSnapshots(Integer pageNo, Integer perPage)
   /**
    * Method returns specific snapshot info by id
    * 
-   * @param snapshotId
+   * @param snapshotId for snapshot
    * @return {@link Snapshot}
    * @throws DigitalOceanException if request had interruption [
    *         <code>HTTP status code &gt;= 400 &amp;&amp; &lt; 510</code>]

src/main/java/com/myjeeva/digitalocean/pojo/Certificate.java

@@ -86,6 +86,10 @@ public Certificate() {
 
   /**
    * Constructor for new certificate create request.
+   * @param name the name for the certificate
+   * @param privateKey the private key
+   * @param leafCertificate the leaf certificate
+   * @param certificateChain the certificate chain
    */
   public Certificate(String name, String privateKey, String leafCertificate,
       String certificateChain) {
@@ -97,6 +101,9 @@ public Certificate(String name, String privateKey, String leafCertificate,
 
   /**
    * Constructor for new Let's Encrypt certificate create request.
+   * @param name the name for the certificate
+   * @param type the type of the certificate
+   * @param dnsNames list of dns names
    */
   public Certificate(String name, String type, List<String> dnsNames) {
     this.name = name;

src/main/java/com/myjeeva/digitalocean/pojo/VolumeAction.java

@@ -76,7 +76,7 @@ public VolumeAction(ActionType type, String regionSlug, Double size) {
    * @param type action type of the volume
    * @param dropletId is to attach/detach volume from droplet
    * @param regionSlug short name of region
-   * @param volumeName
+   * @param volumeName name of the volume
    * @param size volume size in GB
    */
   public VolumeAction(ActionType type, Integer dropletId, String regionSlug, String volumeName,