diff options
| author | BrettyWhite <geekman3454@protonmail.com> | 2019-04-29 15:10:08 -0400 |
|---|---|---|
| committer | BrettyWhite <geekman3454@protonmail.com> | 2019-04-29 15:10:08 -0400 |
| commit | 1c295a6528abcacc6ee4605d0c1b9df564ae5576 (patch) | |
| tree | 3297ed6f44ba7b8bba21ab2a2e3095207e9b9149 | |
| parent | d4c9dde5c146a0b80580a5c749c162bb6d68a073 (diff) | |
| download | sdl_android-1c295a6528abcacc6ee4605d0c1b9df564ae5576.tar.gz | |
add some extra javadocs to classes extending new managers
5 files changed, 28 insertions, 1 deletions
diff --git a/android/sdl_android/src/main/java/com/smartdevicelink/managers/screen/menu/MenuManager.java b/android/sdl_android/src/main/java/com/smartdevicelink/managers/screen/menu/MenuManager.java index b68f55c03..4a28a2792 100644 --- a/android/sdl_android/src/main/java/com/smartdevicelink/managers/screen/menu/MenuManager.java +++ b/android/sdl_android/src/main/java/com/smartdevicelink/managers/screen/menu/MenuManager.java @@ -35,6 +35,13 @@ package com.smartdevicelink.managers.screen.menu; import com.smartdevicelink.managers.file.FileManager; import com.smartdevicelink.proxy.interfaces.ISdl; +/** + * <strong>MenuManager</strong> <br> + * + * Note: This class must be accessed through the ScreenManager via the SdlManager. Do not instantiate it by itself. <br> + * + * The MenuManager takes MenuCell objects and creates and sends all necessary RPCs to build out a menu + */ public class MenuManager extends BaseMenuManager { public MenuManager(ISdl internalInterface, FileManager fileManager) { diff --git a/android/sdl_android/src/main/java/com/smartdevicelink/managers/screen/menu/VoiceCommandManager.java b/android/sdl_android/src/main/java/com/smartdevicelink/managers/screen/menu/VoiceCommandManager.java index 2d48875a5..a892d3a2c 100644 --- a/android/sdl_android/src/main/java/com/smartdevicelink/managers/screen/menu/VoiceCommandManager.java +++ b/android/sdl_android/src/main/java/com/smartdevicelink/managers/screen/menu/VoiceCommandManager.java @@ -34,6 +34,13 @@ package com.smartdevicelink.managers.screen.menu; import com.smartdevicelink.proxy.interfaces.ISdl; +/** + * <strong>VoiceCommandManager</strong> <br> + * + * Note: This class must be accessed through the ScreenManager via the SdlManager. Do not instantiate it by itself. <br> + * + * The VoiceCommandManager takes a List of VoiceCommand objects and sets them on the Head unit for you. + */ public class VoiceCommandManager extends BaseVoiceCommandManager { public VoiceCommandManager(ISdl internalInterface) { diff --git a/base/src/main/java/com/smartdevicelink/managers/screen/menu/BaseMenuManager.java b/base/src/main/java/com/smartdevicelink/managers/screen/menu/BaseMenuManager.java index f58999c47..501f112e7 100644 --- a/base/src/main/java/com/smartdevicelink/managers/screen/menu/BaseMenuManager.java +++ b/base/src/main/java/com/smartdevicelink/managers/screen/menu/BaseMenuManager.java @@ -596,7 +596,6 @@ abstract class BaseMenuManager extends BaseSubManager { if (waitingOnHMIUpdate){ setMenuCells(waitingUpdateMenuCells); waitingUpdateMenuCells.clear(); - return; } } } diff --git a/javaSE/src/main/java/com/smartdevicelink/managers/screen/menu/MenuManager.java b/javaSE/src/main/java/com/smartdevicelink/managers/screen/menu/MenuManager.java index b68f55c03..4a28a2792 100644 --- a/javaSE/src/main/java/com/smartdevicelink/managers/screen/menu/MenuManager.java +++ b/javaSE/src/main/java/com/smartdevicelink/managers/screen/menu/MenuManager.java @@ -35,6 +35,13 @@ package com.smartdevicelink.managers.screen.menu; import com.smartdevicelink.managers.file.FileManager; import com.smartdevicelink.proxy.interfaces.ISdl; +/** + * <strong>MenuManager</strong> <br> + * + * Note: This class must be accessed through the ScreenManager via the SdlManager. Do not instantiate it by itself. <br> + * + * The MenuManager takes MenuCell objects and creates and sends all necessary RPCs to build out a menu + */ public class MenuManager extends BaseMenuManager { public MenuManager(ISdl internalInterface, FileManager fileManager) { diff --git a/javaSE/src/main/java/com/smartdevicelink/managers/screen/menu/VoiceCommandManager.java b/javaSE/src/main/java/com/smartdevicelink/managers/screen/menu/VoiceCommandManager.java index 2d48875a5..a892d3a2c 100644 --- a/javaSE/src/main/java/com/smartdevicelink/managers/screen/menu/VoiceCommandManager.java +++ b/javaSE/src/main/java/com/smartdevicelink/managers/screen/menu/VoiceCommandManager.java @@ -34,6 +34,13 @@ package com.smartdevicelink.managers.screen.menu; import com.smartdevicelink.proxy.interfaces.ISdl; +/** + * <strong>VoiceCommandManager</strong> <br> + * + * Note: This class must be accessed through the ScreenManager via the SdlManager. Do not instantiate it by itself. <br> + * + * The VoiceCommandManager takes a List of VoiceCommand objects and sets them on the Head unit for you. + */ public class VoiceCommandManager extends BaseVoiceCommandManager { public VoiceCommandManager(ISdl internalInterface) { |