Skip to content

Commit

Permalink
More documentation improvements from review
Browse files Browse the repository at this point in the history
  • Loading branch information
ancorgs committed Nov 27, 2015
1 parent 79cc13d commit c7e5510
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions library/general/src/lib/ui/service_status.rb
Expand Up @@ -25,6 +25,10 @@ module UI
#
# As long as #handle_input is invoked in the event loop, the widget will
# handle interactive starting and stopping of the service on user demand.
#
# It also provides checkboxes (reload_flag and enabled_flag) for the user
# to specify whether the service must be reloaded/restarted after
# configuration changes and whether it must be enabled at boot time.
class ServiceStatus
include Yast::UIShortcuts
include Yast::I18n
Expand All @@ -34,6 +38,10 @@ class ServiceStatus
# #name, #start, #stop, #enabled?, #running?
# For systemd compliant services, just do
# Yast::SystemdService.find("name_of_the_service")
# Note that this widget will #start and #stop the service by itself but
# the actions referenced by the flags (reloading and enabling/disabling)
# are expected to be done by the caller, when the whole configuration is
# written.
# @param reload_flag [Boolean] Initial value for the "reload" checkbox.
# Keep in mind it will always be displayed as unchecked if the service
# is not running, despite the real value.
Expand Down

0 comments on commit c7e5510

Please sign in to comment.