summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBilal Alsharifi <bilal.alsharifi@gmail.com>2019-04-12 16:14:24 -0400
committerBilal Alsharifi <bilal.alsharifi@gmail.com>2019-04-12 16:14:24 -0400
commitf40d72f8f7b3f7073d18d87a5d89dd2c05684cfd (patch)
tree3167efeb0c3c966eb316d88f2a322c4eb4e6f7f9
parent75e6a4677533bd490f8871a7bd0fde831d47f256 (diff)
downloadsdl_android-feature/sdlfile_javadoc.tar.gz
Update java docs for SdlFile/SdlArtworkfeature/sdlfile_javadoc
-rw-r--r--android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java6
-rw-r--r--android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java10
-rw-r--r--javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java2
-rw-r--r--javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java4
4 files changed, 11 insertions, 11 deletions
diff --git a/android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java b/android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java
index 1b9c351f4..805fd775a 100644
--- a/android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java
+++ b/android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java
@@ -67,7 +67,7 @@ public class SdlArtwork extends SdlFile {
* 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 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) {
@@ -120,8 +120,8 @@ public class SdlArtwork extends SdlFile {
}
/**
- * 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.
+ * 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) {
diff --git a/android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java b/android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java
index f6385733c..3635c9551 100644
--- a/android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java
+++ b/android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java
@@ -73,7 +73,7 @@ public class 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 uri a URI value representing a file's location. Currently, it only supports local files.
+ * @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){
@@ -142,7 +142,7 @@ public class SdlFile{
/**
* Sets the uri of the file
- * @param uri a URI value representing a file's location. Currently, it only supports local files.
+ * @param uri a URI value representing a file's location. Currently, it only supports local files
*/
public void setUri(Uri uri){
this.uri = uri;
@@ -150,7 +150,7 @@ public class SdlFile{
/**
* Gets the uri of the file
- * @return a URI value representing a file's location. Currently, it only supports local files.
+ * @return a URI value representing a file's location. Currently, it only supports local files
*/
public Uri getUri(){
return uri;
@@ -205,7 +205,7 @@ public class SdlFile{
}
/**
- * Sets the the name of the static file. Static files comes pre-shipped with the head unit.
+ * 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) {
@@ -213,7 +213,7 @@ public class SdlFile{
}
/**
- * Gets the the name of the static file. Static files comes pre-shipped with the head unit.
+ * 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() {
diff --git a/javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java b/javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java
index ebfba504b..6e8085e0a 100644
--- a/javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java
+++ b/javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java
@@ -107,7 +107,7 @@ public class SdlArtwork extends SdlFile {
}
/**
- * Gets 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() {
diff --git a/javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java b/javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java
index 4595e3af9..40bc08b74 100644
--- a/javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java
+++ b/javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java
@@ -171,7 +171,7 @@ public class SdlFile{
}
/**
- * Sets the the name of the static file. Static files comes pre-shipped with the head unit.
+ * 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) {
@@ -179,7 +179,7 @@ public class SdlFile{
}
/**
- * Gets the the name of the static file. Static files comes pre-shipped with the head unit.
+ * 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() {