Fix javadoc warnings (#124)

Author: stefanseifert

src/main/java/io/wcm/handler/media/Asset.java

@@ -38,18 +38,21 @@
 public interface Asset extends Adaptable {
 
   /**
+   * Get title of media item.
    * @return Title of media item
    */
   @Nullable
   String getTitle();
 
   /**
+   * Get alternative text for media item.
    * @return Alternative text for media item
    */
   @Nullable
   String getAltText();
 
   /**
+   * Get description for this media item.
    * @return Description for this media item
    */
   @Nullable
@@ -63,6 +66,7 @@ public interface Asset extends Adaptable {
   String getPath();
 
   /**
+   * Get properties of media item.
    * @return Properties of media item
    */
   @NotNull

src/main/java/io/wcm/handler/media/CropDimension.java

@@ -42,6 +42,7 @@ public final class CropDimension extends Dimension {
   private final boolean autoCrop;
 
   /**
+   * Create crop dimension.
    * @param left Left in pixels
    * @param top Top in pixels
    * @param width Width in pixels
@@ -52,6 +53,7 @@ public CropDimension(long left, long top, long width, long height) {
   }
 
   /**
+   * Create crop dimension with auto-crop flag.
    * @param left Left in pixels
    * @param top Top in pixels
    * @param width Width in pixels
@@ -66,34 +68,39 @@ public CropDimension(long left, long top, long width, long height, boolean autoC
   }
 
   /**
+   * Get left coordinate in pixels.
    * @return Left in pixels
    */
   public long getLeft() {
     return this.left;
   }
 
   /**
+   * Get top coordinate in pixels.
    * @return Top in pixels
    */
   public long getTop() {
     return this.top;
   }
 
   /**
+   * Get right coordinate in pixels.
    * @return Right in pixels
    */
   public long getRight() {
     return getLeft() + getWidth();
   }
 
   /**
+   * Get bottom coordinate in pixels.
    * @return Bottom in pixels
    */
   public long getBottom() {
     return getTop() + getHeight();
   }
 
   /**
+   * Check if dimension is marked as auto-cropped.
    * @return true if is dimenions is marked as auto-cropped
    */
   public boolean isAutoCrop() {
@@ -121,20 +128,23 @@ public String toString() {
   }
 
   /**
+   * Get crop string with coordinates.
    * @return Crop string with left,top,right,bottom.
    */
   public @NotNull String getCropString() {
     return getLeft() + "," + getTop() + "," + getRight() + "," + getBottom();
   }
 
   /**
+   * Get crop string with dimensions.
    * @return Crop string with left,top,width,height.
    */
   public @NotNull String getCropStringWidthHeight() {
     return getLeft() + "," + getTop() + "," + getWidth() + "," + getHeight();
   }
 
   /**
+   * Get rectangle representation of crop dimension.
    * @return Rectangle
    */
   public @NotNull Rectangle2D getRectangle() {

src/main/java/io/wcm/handler/media/Dimension.java

@@ -36,6 +36,7 @@ public class Dimension {
   private final long height;
 
   /**
+   * Create dimension with width and height.
    * @param width Width in pixels
    * @param height Height in pixels
    */
@@ -45,13 +46,15 @@ public Dimension(long width, long height) {
   }
 
   /**
+   * Get width in pixels.
    * @return Width in pixels
    */
   public final long getWidth() {
     return this.width;
   }
 
   /**
+   * Get height in pixels.
    * @return Height in pixels
    */
   public final long getHeight() {

src/main/java/io/wcm/handler/media/Media.java

@@ -62,6 +62,7 @@ public final class Media {
   private String markup;
 
   /**
+   * Create a media object.
    * @param mediaSource Media source
    * @param mediaRequest Processed media request
    */
@@ -71,6 +72,7 @@ public Media(@NotNull MediaSource mediaSource, @NotNull MediaRequest mediaReques
   }
 
   /**
+   * Get media source.
    * @return Media source
    */
   @JsonIgnore
@@ -79,6 +81,7 @@ public Media(@NotNull MediaSource mediaSource, @NotNull MediaRequest mediaReques
   }
 
   /**
+   * Get media handling request.
    * @return Media handling request
    */
   @JsonIgnore
@@ -87,13 +90,15 @@ public Media(@NotNull MediaSource mediaSource, @NotNull MediaRequest mediaReques
   }
 
   /**
+   * Set media handling request.
    * @param mediaRequest Media handling request
    */
   public void setMediaRequest(@NotNull MediaRequest mediaRequest) {
     this.mediaRequest = mediaRequest;
   }
 
   /**
+   * Get HTML element.
    * @return Html element
    */
   @JsonIgnore
@@ -106,6 +111,7 @@ public void setMediaRequest(@NotNull MediaRequest mediaRequest) {
   }
 
   /**
+   * Get media HTML element serialized to string.
    * @return Media HTML element serialized to string. Returns null if media element is null.
    */
   @JsonIgnore
@@ -128,6 +134,7 @@ public void setMediaRequest(@NotNull MediaRequest mediaRequest) {
   }
 
   /**
+   * Set function that builds the HTML element representation on demand.
    * @param value Function that builds the HTML element representation on demand
    */
   public void setElementBuilder(@NotNull Function<Media, HtmlElement> value) {
@@ -136,13 +143,15 @@ public void setElementBuilder(@NotNull Function<Media, HtmlElement> value) {
   }
 
   /**
+   * Get media URL.
    * @return Media URL
    */
   public @Nullable String getUrl() {
     return this.url;
   }
 
   /**
+   * Set media URL.
    * @param value Media URL
    */
   public void setUrl(@Nullable String value) {
@@ -199,6 +208,7 @@ public void setRenditions(@Nullable Collection<Rendition> renditions) {
   }
 
   /**
+   * Get crop dimensions.
    * @return Crop dimensions (optional)
    */
   @JsonIgnore
@@ -207,13 +217,15 @@ public void setRenditions(@Nullable Collection<Rendition> renditions) {
   }
 
   /**
+   * Set crop dimensions.
    * @param cropDimension Crop dimensions (optional)
    */
   public void setCropDimension(@Nullable CropDimension cropDimension) {
     this.cropDimension = cropDimension;
   }
 
   /**
+   * Get image rotation.
    * @return Image rotation (optional)
    */
   @JsonIgnore
@@ -222,13 +234,15 @@ public void setCropDimension(@Nullable CropDimension cropDimension) {
   }
 
   /**
+   * Set image rotation.
    * @param rotation Image Rotation (optional)
    */
   public void setRotation(@Nullable Integer rotation) {
     this.rotation = rotation;
   }
 
   /**
+   * Get image map.
    * @return Image map (optional)
    */
   @JsonIgnore
@@ -237,20 +251,23 @@ public void setRotation(@Nullable Integer rotation) {
   }
 
   /**
+   * Set image map.
    * @param map Image map (optional)
    */
   public void setMap(@Nullable List<ImageMapArea> map) {
     this.map = map;
   }
 
   /**
+   * Check if media is valid.
    * @return true if link is valid and was resolved successfully
    */
   public boolean isValid() {
     return (mediaInvalidReason == null);
   }
 
   /**
+   * Get reason why the requested media could not be resolved.
    * @return Reason why the requested media could not be resolved and is invalid
    */
   @JsonIgnore
@@ -259,13 +276,15 @@ public boolean isValid() {
   }
 
   /**
+   * Set reason why the requested media could not be resolved.
    * @param mediaInvalidReason Reason why the requested media could not be resolved and is invalid
    */
   public void setMediaInvalidReason(@Nullable MediaInvalidReason mediaInvalidReason) {
     this.mediaInvalidReason = mediaInvalidReason;
   }
 
   /**
+   * Get custom message when media invalid reason is CUSTOM.
    * @return Custom message when {@link #getMediaInvalidReason()} is set to {@link MediaInvalidReason#CUSTOM}.
    *         Message is interpreted as i18n key.
    */
@@ -274,6 +293,7 @@ public void setMediaInvalidReason(@Nullable MediaInvalidReason mediaInvalidReaso
   }
 
   /**
+   * Set custom message when media invalid reason is CUSTOM.
    * @param mediaInvalidReasonCustomMessage Custom message when {@link #getMediaInvalidReason()} is set to
    *          {@link MediaInvalidReason#CUSTOM}. Message is interpreted as i18n key.
    */