remi/GarminHomeAssistant
1
0
Fork 0
mirror of https://github.com/house-of-abbey/GarminHomeAssistant.git synced 2025-07-13 16:28:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Code documentation comments were not updated

Browse Source
This commit is contained in:
Philip Abbey
2025-07-10 23:54:05 +01:00
parent 7dd85937fa
commit 906cdf7371
3 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
source/HomeAssistantMenuItemFactory.mc
View File

@ -70,6 +70,7 @@ class HomeAssistantMenuItemFactory {
//! @param label Menu item label. //! @param label Menu item label.
//! @param entity_id Home Assistant Entity ID (optional) //! @param entity_id Home Assistant Entity ID (optional)
//! @param template Template for Home Assistant to render (optional) //! @param template Template for Home Assistant to render (optional)
//! @param exit Should the service call complete and then exit?
//! @param confirm Should this menu item selection be confirmed? //! @param confirm Should this menu item selection be confirmed?
//! @param pin Should this menu item selection request the security PIN? //! @param pin Should this menu item selection request the security PIN?
// //
@ -98,9 +99,10 @@ class HomeAssistantMenuItemFactory {
//! @param entity_id Home Assistant Entity ID (optional) //! @param entity_id Home Assistant Entity ID (optional)
//! @param template Template for Home Assistant to render (optional) //! @param template Template for Home Assistant to render (optional)
//! @param service Template for Home Assistant to render (optional) //! @param service Template for Home Assistant to render (optional)
//! @param data Sourced from the menu JSON, this is the `data` field from the `tap_action` field.
//! @param exit Should the service call complete and then exit?
//! @param confirm Should this menu item selection be confirmed? //! @param confirm Should this menu item selection be confirmed?
//! @param pin Should this menu item selection request the security PIN? //! @param pin Should this menu item selection request the security PIN?
//! @param data Sourced from the menu JSON, this is the `data` field from the `tap_action` field.
// //
function tap( function tap(
label as Lang.String or Lang.Symbol, label as Lang.String or Lang.Symbol,

3
source/HomeAssistantTapMenuItem.mc
View File

@ -32,9 +32,10 @@ class HomeAssistantTapMenuItem extends HomeAssistantMenuItem {
//! @param label Menu item label. //! @param label Menu item label.
//! @param template Menu item template. //! @param template Menu item template.
//! @param service Menu item service. //! @param service Menu item service.
//! @param data Data to supply to the service call.
//! @param exit Should the service call complete and then exit?
//! @param confirm Should the service call be confirmed to avoid accidental invocation? //! @param confirm Should the service call be confirmed to avoid accidental invocation?
//! @param pin Should the service call be protected with a PIN for some low level of security? //! @param pin Should the service call be protected with a PIN for some low level of security?
//! @param data Data to supply to the service call.
//! @param icon Icon to use for the menu item. //! @param icon Icon to use for the menu item.
//! @param options Menu item options to be passed on. //! @param options Menu item options to be passed on.
//! @param haService Shared Home Assistant service object that will perform the required call. Only //! @param haService Shared Home Assistant service object that will perform the required call. Only

3
source/HomeAssistantToggleMenuItem.mc
View File

@ -33,9 +33,10 @@ class HomeAssistantToggleMenuItem extends WatchUi.ToggleMenuItem {
//! //!
//! @param label Menu item label. //! @param label Menu item label.
//! @param template Menu item template. //! @param template Menu item template.
//! @param data Data to supply to the service call.
//! @param exit Should the service call complete and then exit?
//! @param confirm Should the service call be confirmed to avoid accidental invocation? //! @param confirm Should the service call be confirmed to avoid accidental invocation?
//! @param pin Should the service call be protected with a PIN for some low level of security? //! @param pin Should the service call be protected with a PIN for some low level of security?
//! @param data Data to supply to the service call.
//! @param options Menu item options to be passed on. //! @param options Menu item options to be passed on.
// //
function initialize( function initialize(