diff options
author | Heonjae Jang <heonjae.jang@samsung.com> | 2017-05-22 18:28:33 +0900 |
---|---|---|
committer | ChulSeung Kim <charles0.kim@samsung.com> | 2017-06-08 18:34:56 +0900 |
commit | fb268bba3a9107581f2879bdf1ef14dc9f3fd084 (patch) | |
tree | 1bb5e42ef3958d12460db2113b712d1ccbe6460e /TVHome | |
parent | b71b53d118df69b5c7043a0ee15ce29d2b96dd9b (diff) | |
download | home-fb268bba3a9107581f2879bdf1ef14dc9f3fd084.tar.gz home-fb268bba3a9107581f2879bdf1ef14dc9f3fd084.tar.bz2 home-fb268bba3a9107581f2879bdf1ef14dc9f3fd084.zip |
Add and change comment in TVHome, TVApps
Change-Id: I7538cc76d667b2751ced1a681cb81170b95a1cc1
Signed-off-by: Heonjae Jang <heonjae.jang@samsung.com>
Diffstat (limited to 'TVHome')
-rw-r--r-- | TVHome/TVHome.TizenTV/Sniper.cs | 18 | ||||
-rwxr-xr-x | TVHome/TVHome.TizenTV/TVHome.TizenTV.cs | 2 | ||||
-rwxr-xr-x | TVHome/TVHome/Controls/PanelButton.cs | 6 | ||||
-rwxr-xr-x | TVHome/TVHome/TVHome.cs | 12 | ||||
-rwxr-xr-x | TVHome/TVHome/ViewModels/IHomeViewModel.cs | 2 | ||||
-rwxr-xr-x | TVHome/TVHome/ViewModels/MainPageViewModel.cs | 8 | ||||
-rwxr-xr-x | TVHome/TVHome/Views/MainPage.xaml.cs | 2 | ||||
-rwxr-xr-x | TVHome/TVHome/Views/MainPanel.xaml.cs | 13 | ||||
-rwxr-xr-x | TVHome/TVHome/Views/Panel.cs | 6 | ||||
-rwxr-xr-x | TVHome/TVHome/Views/SubPanel.xaml.cs | 15 | ||||
-rwxr-xr-x | TVHome/TVHome/Views/SubThumbnailPanel.xaml.cs | 4 |
11 files changed, 55 insertions, 33 deletions
diff --git a/TVHome/TVHome.TizenTV/Sniper.cs b/TVHome/TVHome.TizenTV/Sniper.cs index 3fc0b5e..22c55f0 100644 --- a/TVHome/TVHome.TizenTV/Sniper.cs +++ b/TVHome/TVHome.TizenTV/Sniper.cs @@ -81,8 +81,8 @@ namespace CoreApp /// <summary> /// A method for handling launched application /// </summary> - /// <param name="appId">A ID of launched application</param> - /// <param name="instanceId">A instance ID of launched application</param> + /// <param name="appId">An ID of launched application</param> + /// <param name="instanceId">An instance ID of launched application</param> private void AddedCallback(string appId, string instanceId) { EventHandler<Event> handler = AddRemoveEvent; @@ -115,8 +115,8 @@ namespace CoreApp /// <summary> /// A method for handling terminated application /// </summary> - /// <param name="appId">A ID of terminated application</param> - /// <param name="instanceId">A instance ID of terminated application</param> + /// <param name="appId">An ID of terminated application</param> + /// <param name="instanceId">An instance ID of terminated application</param> private void RemovedCallback(string appId, string instanceId) { EventHandler<Event> handler = AddRemoveEvent; @@ -149,8 +149,8 @@ namespace CoreApp /// <summary> /// A method for handling application screen is updated /// </summary> - /// <param name="appId">A ID of application that screen is updated</param> - /// <param name="instanceId">A instance ID of application that screen is updated</param> + /// <param name="appId">An ID of application that screen is updated</param> + /// <param name="instanceId">An instance ID of application that screen is updated</param> /// <param name="Filename">A path of application screen shot</param> private void UpdatedCallback(string appId, string instanceId, string Filename) { @@ -184,8 +184,8 @@ namespace CoreApp /// <summary> /// A method for handling screen update is skipped /// </summary> - /// <param name="appId">A ID of application that screen update is skipped</param> - /// <param name="instanceId">A instance ID of application that screen update is skipped</param> + /// <param name="appId">An ID of application that screen update is skipped</param> + /// <param name="instanceId">An instance ID of application that screen update is skipped</param> /// <param name="Filename">A path of application screen shot</param> /// <returns>Returns finish code</returns> private int SkipUpdateCallback(string appId, string instanceId, string Filename) @@ -293,7 +293,7 @@ namespace CoreApp /// <summary> /// A method requests updating application screen shot /// </summary> - /// <param name="instanceId">A instance ID of application</param> + /// <param name="instanceId">An instance ID of application</param> public void RequestUpdate(string instanceId) { try diff --git a/TVHome/TVHome.TizenTV/TVHome.TizenTV.cs b/TVHome/TVHome.TizenTV/TVHome.TizenTV.cs index 9fe9f51..c83c2c7 100755 --- a/TVHome/TVHome.TizenTV/TVHome.TizenTV.cs +++ b/TVHome/TVHome.TizenTV/TVHome.TizenTV.cs @@ -29,7 +29,7 @@ namespace TVHome.TizenTV class Program : global::Xamarin.Forms.Platform.Tizen.FormsApplication { /// <summary> - /// A interface for the platform notification + /// An interface for the platform notification /// </summary> IPlatformNotification notification; /// <summary> diff --git a/TVHome/TVHome/Controls/PanelButton.cs b/TVHome/TVHome/Controls/PanelButton.cs index 6c12bd3..895eff6 100755 --- a/TVHome/TVHome/Controls/PanelButton.cs +++ b/TVHome/TVHome/Controls/PanelButton.cs @@ -66,8 +66,14 @@ namespace TVHome.Controls /// </summary> public ICommand OnClearAllCommand { get; set; } + /// <summary> + /// A Command changes Panel Button to default mode. + /// </summary> public ICommand OnDefaultModeCommand { get; set; } + /// <summary> + /// A Command will be executed the option menus are showed. + /// </summary> public ICommand OnShowOptionsCommand { get; set; } /// <summary> diff --git a/TVHome/TVHome/TVHome.cs b/TVHome/TVHome/TVHome.cs index 213a24a..ac5121d 100755 --- a/TVHome/TVHome/TVHome.cs +++ b/TVHome/TVHome/TVHome.cs @@ -50,27 +50,27 @@ namespace TVHome public static readonly string AppStatus = "appstatus"; /// <summary> - /// A event handler for handling Home key pressed event + /// An event handler for handling Home key pressed event /// </summary> private static EventHandler<TVHomeEventArgs> HomeKeyListener; /// <summary> - /// A event handler for handling Menu key pressed event + /// An event handler for handling Menu key pressed event /// </summary> private static EventHandler<TVHomeEventArgs> MenuKeyListener; /// <summary> - /// A event handler for handling application installed event + /// An event handler for handling application installed event /// </summary> private static EventHandler<TVHomeEventArgs> AppInstalledListener; /// <summary> - /// A event handler for handling application uninstalled event + /// An event handler for handling application uninstalled event /// </summary> private static EventHandler<TVHomeEventArgs> AppUninstalledListener; /// <summary> - /// A event handler for handling application pinned event + /// An event handler for handling application pinned event /// </summary> private static EventHandler<TVHomeEventArgs> AppPinnedNotificationListener; @@ -206,7 +206,7 @@ namespace TVHome /// <summary> /// A method for handling application installed event /// </summary> - /// <param name="pkgID">A installed package ID</param> + /// <param name="pkgID">An installed package ID</param> public void OnAppInstalled(string pkgID) { DebuggingUtils.Dbg("[[[ App Installed ]]] " + pkgID); diff --git a/TVHome/TVHome/ViewModels/IHomeViewModel.cs b/TVHome/TVHome/ViewModels/IHomeViewModel.cs index 1aee6f4..d6d374f 100755 --- a/TVHome/TVHome/ViewModels/IHomeViewModel.cs +++ b/TVHome/TVHome/ViewModels/IHomeViewModel.cs @@ -17,7 +17,7 @@ namespace TVHome.ViewModels { /// <summary> - /// A interface for TV Home MainPageViewModel + /// An interface for TV Home MainPageViewModel /// </summary> interface IHomeViewModel { diff --git a/TVHome/TVHome/ViewModels/MainPageViewModel.cs b/TVHome/TVHome/ViewModels/MainPageViewModel.cs index 493e011..3e5b88f 100755 --- a/TVHome/TVHome/ViewModels/MainPageViewModel.cs +++ b/TVHome/TVHome/ViewModels/MainPageViewModel.cs @@ -129,7 +129,7 @@ namespace TVHome.ViewModels public bool IsShowNoRecentContents { get; set; } /// <summary> - /// A event that is occurred when property of MainPageViewModel is changed + /// An event that is occurred when property of MainPageViewModel is changed /// </summary> public event PropertyChangedEventHandler PropertyChanged; @@ -500,7 +500,7 @@ namespace TVHome.ViewModels /// <summary> /// Removes specified recent application and updates the list to Recent SubPanel /// </summary> - /// <param name="appId">A application ID</param> + /// <param name="appId">An application ID</param> private void RemoveRecentApplication(string appId) { TVHomeImpl.GetInstance.RecentShortcutControllerInstance.Remove(appId); @@ -627,7 +627,7 @@ namespace TVHome.ViewModels /// <summary> /// A method for unpin application /// </summary> - /// <param name="appId">A application ID for unpin</param> + /// <param name="appId">An application ID for unpin</param> private void UnpinAppShortcutInfo(string appId) { RemovePinnedApp(appId); @@ -654,7 +654,7 @@ namespace TVHome.ViewModels /// <summary> /// A method for remove pinned application /// </summary> - /// <param name="appID">A ID of application for removing from pinned application list</param> + /// <param name="appID">An ID of application for removing from pinned application list</param> private async void RemovePinnedApp(string appID) { Dictionary<string, string> PinnedApps = await TVHomeImpl.GetInstance.AppShortcutControllerInstance.GetPinnedAppsAppIDs(); diff --git a/TVHome/TVHome/Views/MainPage.xaml.cs b/TVHome/TVHome/Views/MainPage.xaml.cs index 5780690..8479f6e 100755 --- a/TVHome/TVHome/Views/MainPage.xaml.cs +++ b/TVHome/TVHome/Views/MainPage.xaml.cs @@ -79,7 +79,7 @@ namespace TVHome.Views } /// <summary> - /// Uniconifies the Home screen(Maximize the Home screen) + /// Uniconifies the Home screen(Maximizes the Home screen) /// </summary> private async void Uniconified() { diff --git a/TVHome/TVHome/Views/MainPanel.xaml.cs b/TVHome/TVHome/Views/MainPanel.xaml.cs index 1447636..6e4ad58 100755 --- a/TVHome/TVHome/Views/MainPanel.xaml.cs +++ b/TVHome/TVHome/Views/MainPanel.xaml.cs @@ -52,7 +52,7 @@ namespace TVHome.Views } /// <summary> - /// A event handler for handling property changed event + /// An event handler for handling property changed event /// </summary> /// <param name="sender">The source of the event</param> /// <param name="e">The event that is occurred when property is changed</param> @@ -103,7 +103,7 @@ namespace TVHome.Views /// <summary> /// A method for getting focusable element of Panel Button /// </summary> - /// <param name="index">A index of panel button to get</param> + /// <param name="index">An index of panel button to get</param> /// <returns>A Button element of Panel Button</returns> public Button GetButtonToFocusing(int index) { @@ -147,18 +147,23 @@ namespace TVHome.Views /// <summary> /// A method for setting focus to Panel Button /// </summary> - /// <param name="index">A index of Panel Button to set focus</param> + /// <param name="index">An index of Panel Button to set focus</param> public void SetButtonFocus(int index) { var button = PanelButtonGrid.Children[index]; button.FindByName<Button>("ButtonFocusArea").Focus(); } - + /// <summary> + /// A method for handling when menu key is pressed + /// </summary> public override void MenuKeyPressed() { } + /// <summary> + /// A method for handling to hide panel without animation + /// </summary> public override void ForceHidePanel() { } diff --git a/TVHome/TVHome/Views/Panel.cs b/TVHome/TVHome/Views/Panel.cs index a5cbb61..bb2e57c 100755 --- a/TVHome/TVHome/Views/Panel.cs +++ b/TVHome/TVHome/Views/Panel.cs @@ -119,7 +119,7 @@ namespace TVHome.Views /// <summary> /// A Event Handler invoker method. /// </summary> - /// <param name="e">A event argument. But this is always EventArgs.Empty</param> + /// <param name="e">An event argument. But this is always EventArgs.Empty</param> protected virtual void OnItemSourceChanged(EventArgs e) { EventHandler handler = ItemSourceChanged; @@ -144,11 +144,15 @@ namespace TVHome.Views /// A flag indicates whether the panel is focused or not /// </summary> public bool isFocused; + /// <summary> /// A flag indicates whether the panel is move mode or not /// </summary> public bool isMoveMode; + /// <summary> + /// A flag indicates wheter the ContextPopup Menu is shown or not + /// </summary> public bool isShowOptions; /// <summary> diff --git a/TVHome/TVHome/Views/SubPanel.xaml.cs b/TVHome/TVHome/Views/SubPanel.xaml.cs index 145d4f4..80e5189 100755 --- a/TVHome/TVHome/Views/SubPanel.xaml.cs +++ b/TVHome/TVHome/Views/SubPanel.xaml.cs @@ -51,6 +51,10 @@ namespace TVHome.Views /// </summary> private int selectTransitionHeight = SizeUtils.GetHeightSize(146); + /// <summary> + /// A method for getting Panel Buttons + /// </summary> + /// <returns>A list of panel button views</returns> public IList<View> GetSubPanelButtons() { return PanelButtonStack.Children; @@ -71,7 +75,9 @@ namespace TVHome.Views PropertyChanged += OnItemsSourcePropertyChanged; } - + /// <summary> + /// A method for handling when menu key is pressed + /// </summary> public override void MenuKeyPressed() { isShowOptions = true; @@ -93,8 +99,9 @@ namespace TVHome.Views } } } + /// <summary> - /// A event handler for handling property changed event + /// An event handler for handling property changed event /// </summary> /// <param name="sender">A source of event</param> /// <param name="e">The event that is occurred when property is changed</param> @@ -372,7 +379,7 @@ namespace TVHome.Views /// <summary> /// A method for moving the selected item to right /// </summary> - /// <param name="index">A index of item to be moved</param> + /// <param name="index">An index of item to be moved</param> /// <param name="button">TODO : Comment this</param> private void MoveItemToRight(int index, PanelButton button) { @@ -419,7 +426,7 @@ namespace TVHome.Views /// <summary> /// A method for moving the selected item to left /// </summary> - /// <param name="index">A index of item to be moved</param> + /// <param name="index">An index of item to be moved</param> /// <param name="button">TODO : Comment this</param> private void MoveItemToLeft(int index, PanelButton button) { diff --git a/TVHome/TVHome/Views/SubThumbnailPanel.xaml.cs b/TVHome/TVHome/Views/SubThumbnailPanel.xaml.cs index fc1facc..3e293a3 100755 --- a/TVHome/TVHome/Views/SubThumbnailPanel.xaml.cs +++ b/TVHome/TVHome/Views/SubThumbnailPanel.xaml.cs @@ -72,7 +72,7 @@ namespace TVHome.Views } /// <summary> - /// + /// A method for handling when menu key is pressed /// </summary> public override void MenuKeyPressed() { @@ -89,7 +89,7 @@ namespace TVHome.Views } /// <summary> - /// A event handler for handling property changed event + /// An event handler for handling property changed event /// </summary> /// <param name="sender">A source of event</param> /// <param name="e">The event that is occurred when property is changed</param> |