Merge pull request #234 from martiner/jmi-trivial

trivial: fix javadoc formatting and warnings

Author: liry

src/main/java/com/gooddata/GoodData.java

@@ -165,6 +165,7 @@ public GoodData(String hostname, String login, String password, int port, GoodDa
      * @param password GoodData user's password
      * @param port     GoodData Platform's API port (e.g. 443)
      * @param protocol GoodData Platform's API protocol (e.g. https)
+     * @param settings additional settings
      */
     protected GoodData(String hostname, String login, String password, int port, String protocol, GoodDataSettings settings) {
         notEmpty(hostname, "hostname");

src/main/java/com/gooddata/GoodDataSettings.java

@@ -7,7 +7,7 @@
 /**
  * Gather various additional settings of {@link GoodData}. Can be passed to the {@link GoodData} constructor to tune up
  * it's behaviour.
- * <p/>
+ * <p>
  * Settings are applied only once at the beginning. Changing this bean after it's passed to {@link GoodData} has
  * no effect.
  */
@@ -22,7 +22,7 @@ public class GoodDataSettings {
     /**
      * Set maximum number of connections used. This applies same for connections per host as for total connections.
      * (As we assume GoodData connects to single host).
-     * <p/>
+     * <p>
      * The default value is 20.
      *
      * @param maxConnections maximum number of connections used.
@@ -43,9 +43,9 @@ public int getMaxConnections() {
 
     /**
      * Set timeout milliseconds until connection established.
-     * <p/>
+     * <p>
      * The default value is 10 seconds (10000 ms).
-     * <p/>
+     * <p>
      * Set to 0 for infinite.
      *
      * @param connectionTimeout connection timeout milliseconds
@@ -57,9 +57,9 @@ public void setConnectionTimeout(int connectionTimeout) {
 
     /**
      * Set timeout seconds until connection established.
-     * <p/>
+     * <p>
      * The default value is 10 seconds.
-     * <p/>
+     * <p>
      * Set to 0 for infinite.
      *
      * @param connectionTimeout connection timeout seconds
@@ -79,9 +79,9 @@ public int getConnectionTimeout() {
 
     /**
      * Set timeout in milliseconds used when requesting a connection from the connection manager.
-     * <p/>
+     * <p>
      * The default value is 10 seconds (10000 ms).
-     * <p/>
+     * <p>
      * Set to 0 for infinite.
      *
      * @param connectionRequestTimeout connection request timeout milliseconds
@@ -93,11 +93,11 @@ public void setConnectionRequestTimeout(final int connectionRequestTimeout) {
 
     /**
      * Set timeout in seconds used when requesting a connection from the connection manager.
-     * <p/>
+     * <p>
      * The default value is 10 seconds.
-     * <p/>
+     * <p>
      * Set to 0 for infinite.
-     * <p/>
+     * <p>
      *
      * @param connectionRequestTimeout connection request timeout seconds
      */
@@ -116,9 +116,9 @@ public int getConnectionRequestTimeout() {
 
     /**
      * Set socket timeout (maximum period inactivity between two consecutive data packets) milliseconds.
-     * <p/>
+     * <p>
      * The default value is 60 seconds (60000 ms).
-     * <p/>
+     * <p>
      * Set to 0 for infinite.
      *
      * @param socketTimeout socket timeout milliseconds
@@ -130,9 +130,9 @@ public void setSocketTimeout(int socketTimeout) {
 
     /**
      * Set socket timeout (maximum period inactivity between two consecutive data packets) seconds.
-     * <p/>
+     * <p>
      * The default value is 60 seconds.
-     * <p/>
+     * <p>
      * Set to 0 for infinite.
      *
      * @param socketTimeout socket timeout seconds

src/main/java/com/gooddata/md/Meta.java

@@ -151,6 +151,7 @@ public String getUri() {
 
     /**
      * Default is false/not-deprecated.
+     * @return true when the linked object is deprecated, null if not set
      */
     @JsonProperty("deprecated")
     @JsonSerialize(using = BooleanStringSerializer.class, include = Inclusion.NON_NULL)
@@ -174,6 +175,7 @@ public void setIdentifier(String identifier) {
 
     /**
      * Is the object production or not? Defaults to true.
+     * @return true when the linked object is production, null if not set
      */
     @JsonProperty("isProduction")
     @JsonSerialize(using = BooleanIntegerSerializer.class, include = Inclusion.NON_NULL)
@@ -189,6 +191,7 @@ public void setProduction(final Boolean production) {
 
     /**
      * Flag that MD object is locked; default is false/unlocked.
+     * @return true when the linked object is locked, null if not set
      */
     @JsonProperty("locked")
     @JsonSerialize(using = BooleanIntegerSerializer.class, include = Inclusion.NON_NULL)
@@ -204,6 +207,7 @@ public void setLocked(Boolean locked) {
 
     /**
      * Default is false/listed.
+     * @return true when the linked object is unlisted, null if not set
      */
     @JsonProperty("unlisted")
     @JsonSerialize(using = BooleanIntegerSerializer.class, include = Inclusion.NON_NULL)
@@ -219,6 +223,7 @@ public void setUnlisted(Boolean unlisted) {
 
     /**
      * Is the linked object shared with someone via ACLs?
+     * @return true when the linked object is shared, null if not set
      */
     @JsonProperty("sharedWithSomeone")
     @JsonSerialize(using = BooleanIntegerSerializer.class, include = Inclusion.NON_NULL)

src/main/java/com/gooddata/md/MetadataService.java

@@ -300,6 +300,7 @@ public <T extends Queryable> Collection<String> findUris(Project project,
 
     /**
      * Find all objects which use the given object.
+     * @param project project
      * @param obj     object to find using objects for
      * @param nearest find nearest objects only
      * @param types   what types (categories) to search for (for example 'reportDefinition', 'report', 'tableDataLoad',
@@ -313,6 +314,7 @@ public Collection<Entry> usedBy(Project project, Obj obj, boolean nearest, Class
 
     /**
      * Find all objects which use the given object.
+     * @param project project
      * @param uri     URI of object to find using objects for
      * @param nearest find nearest objects only
      * @param types   what types (categories) to search for (for example 'reportDefinition', 'report', 'tableDataLoad',

src/main/java/com/gooddata/project/ProjectService.java

@@ -403,6 +403,7 @@ public List<ProjectFeatureFlag> listFeatureFlags(Project project) {
      *
      * @param project project for which the feature flag should be created, cannot be null
      * @param featureFlag feature flag to be created, cannot be null
+     * @return created feature flag
      */
     public ProjectFeatureFlag createFeatureFlag(final Project project, final ProjectFeatureFlag featureFlag) {
         notNull(project, "project");

src/main/java/com/gooddata/warehouse/WarehouseService.java

@@ -157,6 +157,7 @@ public PageableList<Warehouse> listWarehouses() {
      * Lists Warehouses. Returns empty list in case there are no warehouses.
      * Returns requested page (by page limit and offset). Use {@link #listWarehouses()} to get first page with default setting.
      *
+     * @param page page to be listed
      * @return requested page of list of instances or empty list
      */
     public PageableList<Warehouse> listWarehouses(Page page) {