Add javadoc to SdlFile & SdlArtwork (#1041)

* Add java doc for SdlFile

* Add javadoc to sdl Artwork

* Add more javadoc SdlFile & SdlArtwork

* Update java docs for SdlFile/SdlArtwork

Author: bilal-alsharifi

android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java

@@ -47,34 +47,62 @@ public class SdlArtwork extends SdlFile {
     private boolean isTemplate;
     private Image imageRPC;
 
+    /**
+     * Creates a new instance of SdlArtwork
+     */
     public SdlArtwork(){}
 
+    /**
+     * Creates a new instance of SdlArtwork
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileType a FileType enum value representing the type of the file
+     * @param id an int value representing the android resource id of the file
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public SdlArtwork(@NonNull String fileName, @NonNull FileType fileType, int id, boolean persistentFile) {
         super(fileName, fileType, id, persistentFile);
     }
 
+    /**
+     * Creates a new instance of SdlArtwork
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileType a FileType enum value representing the type of the file
+     * @param uri a URI value representing a file's location. Currently, it only supports local files
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public SdlArtwork(@NonNull String fileName, @NonNull FileType fileType, Uri uri, boolean persistentFile) {
         super(fileName, fileType, uri, persistentFile);
     }
 
+    /**
+     * Creates a new instance of SdlArtwork
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileType a FileType enum value representing the type of the file
+     * @param data a byte array representing the data of the file
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public SdlArtwork(@NonNull String fileName, @NonNull FileType fileType, byte[] data, boolean persistentFile) {
         super(fileName, fileType, data, persistentFile);
     }
 
+    /**
+     * Creates a new instance of SdlArtwork
+     * @param staticIconName a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit
+     */
     public SdlArtwork(@NonNull StaticIconName staticIconName) {
         super(staticIconName);
     }
 
     /**
-     * Set whether this SdlArtwork is a template image whose coloring should be decided by the HMI
+     * Sets whether this SdlArtwork is a template image whose coloring should be decided by the HMI
      * @param isTemplate boolean that tells whether this SdlArtwork is a template image
      */
     public void setTemplateImage(boolean isTemplate){
         this.isTemplate = isTemplate;
     }
 
     /**
-     * Get whether this SdlArtwork is a template image whose coloring should be decided by the HMI
+     * Gets whether this SdlArtwork is a template image whose coloring should be decided by the HMI
      * @return boolean that tells whether this SdlArtwork is a template image
      */
     public boolean isTemplateImage(){
@@ -92,8 +120,8 @@ public void setType(@NonNull FileType fileType) {
     }
 
     /**
-     * Get the Image RPC representing this artwork. Generally for use internally, you should instead pass an artwork to a Screen Manager method.
-     * @return The Image RPC representing this artwork.
+     * Gets the Image RPC representing this artwork. Generally for use internally, you should instead pass an artwork to a Screen Manager method
+     * @return The Image RPC representing this artwork
      */
     public Image getImageRPC() {
         if (imageRPC == null) {

android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java

@@ -50,82 +50,172 @@ public class SdlFile{
     private boolean     persistentFile;
     private boolean     isStaticIcon;
 
-
+    /**
+     * Creates a new instance of SdlFile
+     */
     public SdlFile(){}
 
+    /**
+     * Creates a new instance of SdlFile
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileType a FileType enum value representing the type of the file
+     * @param id an int value representing the android resource id of the file
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public SdlFile(@NonNull String fileName, @NonNull FileType fileType, int id, boolean persistentFile){
         this.fileName = fileName;
         this.fileType = fileType;
         this.id = id;
         this.persistentFile = persistentFile;
     }
 
+    /**
+     * Creates a new instance of SdlFile
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileType a FileType enum value representing the type of the file
+     * @param uri a URI value representing a file's location. Currently, it only supports local files
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public SdlFile(@NonNull String fileName, @NonNull FileType fileType, Uri uri, boolean persistentFile){
         this.fileName = fileName;
         this.fileType = fileType;
         this.uri = uri;
         this.persistentFile = persistentFile;
     }
 
+    /**
+     * Creates a new instance of SdlFile
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileType a FileType enum value representing the type of the file
+     * @param data a byte array representing the data of the file
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public SdlFile(@NonNull String fileName, @NonNull FileType fileType, byte[] data, boolean persistentFile){
         this.fileName = fileName;
         this.fileType = fileType;
         this.fileData = data;
         this.persistentFile = persistentFile;
     }
 
+    /**
+     * Creates a new instance of SdlFile
+     * @param staticIconName a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit
+     */
     public SdlFile(@NonNull StaticIconName staticIconName){
         this.fileName = staticIconName.toString();
         this.fileData = staticIconName.toString().getBytes();
         this.persistentFile = false;
         this.isStaticIcon = true;
     }
 
+    /**
+     * Sets the name of the file
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     */
     public void setName(@NonNull String fileName){
         this.fileName = fileName;
     }
+
+    /**
+     * Gets the name of the file
+     * @return a String value representing the name that will be used to store the file in the head unit
+     */
     public String getName(){
         return fileName;
     }
 
+    /**
+     * Sets the resource ID of the file
+     * @param id an int value representing the android resource id of the file
+     */
     public void setResourceId(int id){
         this.id = id;
     }
+
+    /**
+     * Gets the resource id of the file
+     * @return an int value representing the android resource id of the file
+     */
     public int getResourceId(){
         return id;
     }
 
+    /**
+     * Sets the uri of the file
+     * @param uri a URI value representing a file's location. Currently, it only supports local files
+     */
     public void setUri(Uri uri){
         this.uri = uri;
     }
+
+    /**
+     * Gets the uri of the file
+     * @return a URI value representing a file's location. Currently, it only supports local files
+     */
     public Uri getUri(){
         return uri;
     }
 
+    /**
+     * Sets the byte array that represents the content of the file
+     * @param data a byte array representing the data of the file
+     */
     public void setFileData(byte[] data){
         this.fileData = data;
     }
+
+    /**
+     * Gets the byte array that represents the content of the file
+     * @return a byte array representing the data of the file
+     */
     public byte[] getFileData(){
         return fileData;
     }
 
+    /**
+     * Sets the type of the file
+     * @param fileType a FileType enum value representing the type of the file
+     */
     public void setType(@NonNull FileType fileType){
         this.fileType = fileType;
     }
+
+    /**
+     * Gets the type of the file
+     * @return a FileType enum value representing the type of the file
+     */
     public FileType getType(){
         return fileType;
     }
 
+    /**
+     * Sets whether the file should persist between sessions / ignition cycles
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public void setPersistent(boolean persistentFile){
         this.persistentFile = persistentFile;
     }
+
+    /**
+     * Gets whether the file should persist between sessions / ignition cycles
+     * @return a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public boolean isPersistent(){
         return this.persistentFile;
     }
 
+    /**
+     * Sets the the name of the static file. Static files comes pre-shipped with the head unit
+     * @param staticIcon a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit
+     */
     public void setStaticIcon(boolean staticIcon) {
         isStaticIcon = staticIcon;
     }
+
+    /**
+     * Gets the the name of the static file. Static files comes pre-shipped with the head unit
+     * @return a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit
+     */
     public boolean isStaticIcon() {
         return isStaticIcon;
     }

javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java

@@ -44,30 +44,51 @@ public class SdlArtwork extends SdlFile {
     private boolean isTemplate;
     private Image imageRPC;
 
+    /**
+     * Creates a new instance of SdlArtwork
+     */
     public SdlArtwork(){}
 
-    public SdlArtwork(@NonNull StaticIconName staticIconName) {
-        super(staticIconName);
-    }
-
+    /**
+     * Creates a new instance of SdlArtwork
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileType a FileType enum value representing the type of the file
+     * @param filePath a String value representing the the location of the file
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public SdlArtwork(@NonNull String fileName, @NonNull FileType fileType, String filePath, boolean persistentFile) {
         super(fileName, fileType, filePath, persistentFile);
     }
 
+    /**
+     * Creates a new instance of SdlArtwork
+     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileType a FileType enum value representing the type of the file
+     * @param data a byte array representing the data of the file
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
     public SdlArtwork(@NonNull String fileName, @NonNull FileType fileType, byte[] data, boolean persistentFile) {
         super(fileName, fileType, data, persistentFile);
     }
 
     /**
-     * Set whether this SdlArtwork is a template image whose coloring should be decided by the HMI
+     * Creates a new instance of SdlArtwork
+     * @param staticIconName a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit
+     */
+    public SdlArtwork(@NonNull StaticIconName staticIconName) {
+        super(staticIconName);
+    }
+
+    /**
+     * Sets whether this SdlArtwork is a template image whose coloring should be decided by the HMI
      * @param isTemplate boolean that tells whether this SdlArtwork is a template image
      */
     public void setTemplateImage(boolean isTemplate){
         this.isTemplate = isTemplate;
     }
 
     /**
-     * Get whether this SdlArtwork is a template image whose coloring should be decided by the HMI
+     * Gets whether this SdlArtwork is a template image whose coloring should be decided by the HMI
      * @return boolean that tells whether this SdlArtwork is a template image
      */
     public boolean isTemplateImage(){
@@ -86,7 +107,7 @@ public void setType(@NonNull FileType fileType) {
     }
 
     /**
-     * Get the Image RPC representing this artwork. Generally for use internally, you should instead pass an artwork to a Screen Manager method.
+     * Gets the Image RPC representing this artwork. Generally for use internally, you should instead pass an artwork to a Screen Manager method
      * @return The Image RPC representing this artwork.
      */
     public Image getImageRPC() {