omf_rc 6.0.2.pre.2 → 6.0.2

data/lib/omf_rc/resource_proxy/application.rb

@@ -1,25 +1,8 @@
-#
-# Copyright (c) 2012 National ICT Australia (NICTA), Australia
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
 
-#
 # This module defines a Resource Proxy (RP) for an Application.
 # For a detailed usage tutorial see {file:doc/RESOURCE\_PROXY.mkd Resource Proxy tutorial}
 #
@@ -89,9 +72,13 @@
 #
 module OmfRc::ResourceProxy::Application
   include OmfRc::ResourceProxyDSL
+  # @!macro extend_dsl
+
   require 'omf_common/exec_app'
 
   register_proxy :application
+  # @!parse include OmfRc::Util::PlatformTools
+  # @!parse include OmfRc::Util::CommonTools
   utility :platform_tools
   utility :common_tools
 
@@ -119,10 +106,14 @@ module OmfRc::ResourceProxy::Application
   property :oml_logfile, :default => nil
   property :oml_loglevel, :default => nil
 
+  # @!macro group_hook
+  #
   # hook :before_ready do |res|
     # define_method("on_app_event") { |*args| process_event(self, *args) }
   # end
 
+  # @!macro hook
+  # @!method after_initial_configured
   hook :after_initial_configured do |res|
     # if state was set to running or installing from the create we need
     # to make sure that this happens!
@@ -135,55 +126,71 @@ module OmfRc::ResourceProxy::Application
     end
   end
 
+  # @!endgroup
+
   # This method processes an event coming from the application instance, which
   # was started by this Resource Proxy (RP). It is a callback, which is usually
   # called by the ExecApp class in OMF
   #
   # @param [AbstractResource] res this RP
   # @param [String] event_type the type of event from the app instance
-  #                 (STARTED, DONE.OK, DONE.ERROR, STDOUT, STDERR)
+  #                 (STARTED, EXIT, STDOUT, STDERR)
   # @param [String] app_id the id of the app instance
   # @param [String] msg the message carried by the event
-  #
   def process_event(res, event_type, app_id, msg)
       logger.info "App Event from '#{app_id}' "+
                   "(##{res.property.event_sequence}) - "+
                   "#{event_type}: '#{msg}'"
-      if event_type.to_s.include?('DONE')
+      res.property.event_sequence += 1
+      res.property.installed = true if app_id.include?("_INSTALL") &&
+                                       event_type.to_s.include?('EXIT') &&
+                                       msg == "0"
+      if event_type == 'EXIT'
         res.property.state = app_id.include?("_INSTALL") ? :stopped : :completed
         res.inform(:status, {
+                        status_type: 'APP_EVENT',
+                        event: event_type.to_s.upcase,
+                        app: app_id,
+                        exit_code: msg,
+                        msg: msg,
                         state: res.property.state,
-                        uid: res.uid # do we really need this? SHould be identical to 'src'
+                        seq: res.property.event_sequence,
+                        uid: res.uid # do we really need this? Should be identical to 'src'
                       }, :ALL)
+      else
+        res.inform(:status, {
+                      status_type: 'APP_EVENT',
+                      event: event_type.to_s.upcase,
+                      app: app_id,
+                      msg: msg,
+                      seq: res.property.event_sequence,
+                      uid: res.uid
+                    }, :ALL)
       end
-
-      res.inform(:status, {
-                    status_type: 'APP_EVENT',
-                    event: event_type.to_s.upcase,
-                    app: app_id,
-                    msg: msg,
-                    seq: res.property.event_sequence,
-                    uid: res.uid
-                  }, :ALL)
-      
-      
-
-      res.property.event_sequence += 1
-      res.property.installed = true if app_id.include?("_INSTALL") &&
-                                       event_type.to_s.include?('DONE.OK')
   end
 
+  # @!macro group_request
+  #
   # Request the platform property of this Application RP
   # @see OmfRc::ResourceProxy::Application
   #
+  # @!macro request
+  # @!method request_platform
   request :platform do |res|
     res.property.platform = detect_platform if res.property.platform.nil?
     res.property.platform.to_s
   end
 
+  # @!endgroup
+  # @!macro group_configure
+
   # Configure the environments and oml property of this Application RP
   # @see OmfRc::ResourceProxy::Application
   #
+  #
+  # @!macro configure
+  # @!method conifgure_environments
+  # @!method conifgure_oml
   %w(environments oml).each do |prop|
     configure(prop) do |res, value|
       if value.kind_of? Hash
@@ -197,7 +204,10 @@ module OmfRc::ResourceProxy::Application
   end
 
   # Configure the parameters property of this Application RP
+  #
+  # @!macro configure
   # @see OmfRc::ResourceProxy::Application
+  # @!method configure_parameters
   #
   configure :parameters do |res, params|
     if params.kind_of? Hash
@@ -235,7 +245,7 @@ module OmfRc::ResourceProxy::Application
   # stopped, running, paused, installing. The semantic of each states are:
   #
   # - stopped: the initial state for an Application RP
-  # - completed: the final state for an applicaiton RP. When the application
+  # - completed: the final state for an application RP. When the application
   #   has been executed and its execution is finished, it enters this state.
   #   When the application is completed it cannot change state again
   #   TODO: maybe in future OMF, we could consider allowing an app to be reset?
@@ -257,8 +267,9 @@ module OmfRc::ResourceProxy::Application
   #   only when the installatio is done. Supported install methods are: Tarball,
   #   Ubuntu, and Fedora
   #
-  # @yieldparam [String] value the state to set this app into
-  #
+  # @param [String] value the state to set this app into
+  # @!macro configure
+  # @!method configure_state
   configure :state do |res, value|
     OmfCommon.eventloop.after(0) do
       case value.to_s.downcase.to_sym
@@ -273,9 +284,14 @@ module OmfRc::ResourceProxy::Application
     res.property.state
   end
 
+  # @!endgroup
+
+  # @!macro group_work
+  #
   # Swich this Application RP into the 'installing' state
   # (see the description of configure :state)
-  #
+  # @!macro work
+  # @!method switch_to_installing
   work('switch_to_installing') do |res|
     if res.property.state.to_sym == :stopped
       if res.property.installed
@@ -301,9 +317,11 @@ module OmfRc::ResourceProxy::Application
     end
   end
 
-  # Swich this Application RP into the 'stopped' state
+  # Switch this Application RP into the 'stopped' state
   # (see the description of configure :state)
   #
+  # @!macro work
+  # @!method switch_to_stopped
   work('switch_to_stopped') do |res|
     if res.property.state == :running || res.property.state == :paused
       id = res.property.app_id
@@ -332,6 +350,8 @@ module OmfRc::ResourceProxy::Application
   # Switch this Application RP into the 'running' state
   # (see the description of configure :state)
   #
+  # @!macro work
+  # @!method switch_to_running
   work('switch_to_running') do |res|
     if res.property.state == :stopped
       # start a new instance of this app
@@ -360,6 +380,8 @@ module OmfRc::ResourceProxy::Application
   # Swich this Application RP into the 'paused' state
   # (see the description of configure :state)
   #
+  # @!macro work
+  # @!method switch_to_paused
   work('switch_to_paused') do |res|
     if res.property.state == :running
       # pause this app
@@ -375,6 +397,8 @@ module OmfRc::ResourceProxy::Application
   # @yieldparam [Hash] att the Hash holding the parameter's attributs
   # @see OmfRc::ResourceProxy::Application
   #
+  # @!macro work
+  # @!method dynamic_parameter_update
   work('dynamic_parameter_update') do |res,name,att|
     # Only update a parameter if it is dynamic and the application is running
     dynamic = false
@@ -399,10 +423,10 @@ module OmfRc::ResourceProxy::Application
   # - third if no value is given but a default is given, then perform the same
   #   check as above but using the default in-place of the value
   #
-  # @yieldparam [Hash] att the Hash holding the parameter's attributs
-  #
-  # [Boolean] true or false
+  # @param [Hash] att the Hash holding the parameter's attributs
   #
+  # @return [Boolean] true or false
+  # @!macro work
   work('pass_type_checking?') do |res,att|
     passed = false
     unless att[:type].nil?
@@ -444,8 +468,8 @@ module OmfRc::ResourceProxy::Application
   # this Application Resource Proxy. If the 'use_oml' property is set, then
   # add to the command line the necessary oml parameters.
   #
-  # [String] the full command line
-  #
+  # @return [String] the full command line
+  # @!macro work
   work('build_command_line') do |res|
     cmd_line = "env -i " # Start with a 'clean' environments
     res.property.environments.each do |e,v|
@@ -509,10 +533,10 @@ module OmfRc::ResourceProxy::Application
   # the corresponsding 'oml_logfile' and 'oml_loglevel' properties are set for
   # this application resource.
   #
-  # @yieldparam [String] cmd the String to which OML parameters will be added
-  #
-  # [String] the resulting command line
+  # @param [String] cmd the String to which OML parameters will be added
   #
+  # @return [String] the resulting command line
+  # @!macro work
   work('build_oml_config') do |res, cmd|
     if !res.property.oml_configfile.nil?
       if File.exist?(res.property.oml_configfile)

data/lib/omf_rc/resource_proxy/net.rb

@@ -1,8 +1,35 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
+# Proxy for managing Ethernet interfaces
+#
+# Net resources can be created as children of {OmfRc::ResourceProxy::Node}.
+#
+# It is important to set if_name (interface_name) as they are used as identifier for executing ip commands.
+#
+# @example Bring up an Ethernet interface eth0 by setting an ip address
+#   eth0 = node.create(:wlan, if_name: 'eth0')
+#   eth0.conifgure_ip_addr("192.168.1.100/24")
+#
+# @see OmfRc::Util::Ip
 module OmfRc::ResourceProxy::Net
   include OmfRc::ResourceProxyDSL
-  
+  # @!macro extend_dsl
+
   register_proxy :net
-  property :if_name, :default => "eth0"
+
+  # @!parse include OmfRc::Util::Ip
+  # @!parse include OmfRc::Util::Sysfs
   utility :ip
   utility :sysfs
+
+  # @!macro group_prop
+  #
+  # @!attribute [rw] if_name
+  #   Interface name, default is 'eth0'.
+  #   @!macro prop
+  property :if_name, :default => "eth0"
+  # @!endgroup
 end

data/lib/omf_rc/resource_proxy/node.rb

@@ -1,30 +1,81 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
+# This proxy represents physical/virtual machine node, and it is the proxy which standard RC start up script initialised.
+#
+# Node proxy is more like a monitor proxy which monitors resource information on the node itself, it is usually created during the bootstrap process and provides an entry point for incoming FRCP messages.
+#
+# Resources like application, net, or wlan can be created as children of node resources by sending FRCP create messages to the node's pubsub topic.
+#
+# @example Creating an ethernet resource on an existing node 'node01' using communicator
+#   comm.subscribe('node01') do |node|
+#     node.create(:net, if_name: 'eth0')
+#   end
+#
+# @example Creating an ethernet resource on an existing node 'node01' directly
+#   node = OmfRc::ResourceFactory.create(:node)
+#   node.create(:net, if_name: 'eth0')
+#
+# @see OmfRc::ResourceProxy::Application
+# @see OmfRc::ResourceProxy::Net
+# @see OmfRc::ResourceProxy::Wlan
 module OmfRc::ResourceProxy::Node
   include OmfRc::ResourceProxyDSL
+  # @!macro extend_dsl
 
   register_proxy :node
 
+  # @!parse include OmfRc::Util::Mod
+  # @!parse include OmfRc::Util::Sysfs
   utility :mod
   utility :sysfs
 
+  # @!macro group_request
+  #
+  # Created interfaces
+  #
+  # @example
+  #   [{ name: 'eth0', type: 'net', uid: 'RWED2123' }]
+  # @return [Array<Hash>]
+  # @!macro request
+  # @!method request_interface
   request :interfaces do |node|
     node.children.find_all { |v| v.type == :net || v.type == :wlan }.map do |v|
       { name: v.property.if_name, type: v.type, uid: v.uid }
     end.sort { |x, y| x[:name] <=> y[:name] }
   end
 
+  # Created applications
+  #
+  # @example
+  #   [{ name: 'my_app', type: 'application', uid: 'E232ER1' }]
+  # @return [Array<Hash>]
+  # @!macro request
+  # @!method request_applications
   request :applications do |node|
     node.children.find_all { |v| v.type =~ /application/ }.map do |v|
       { name: v.hrn, type: v.type, uid: v.uid }
     end.sort { |x, y| x[:name] <=> y[:name] }
   end
 
+  # @!endgroup
+
+  # @!macro group_hook
+  #
+  # Check if device exists
+  #
+  # @raise [StandardError] if device not found on the node
+  #
+  # @!method before_create
   hook :before_create do |node, type, opts|
     if type.to_sym == :net
       net_dev = node.request_devices.find do |v|
         v[:name] == opts[:if_name]
       end
-      raise "Device '#{opts[:if_name]}' not found" if net_dev.nil?
+      raise StandardError, "Device '#{opts[:if_name]}' not found" if net_dev.nil?
     end
   end
-
+  # @!endgroup
 end

data/lib/omf_rc/resource_proxy/virtual_machine.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 #
 # Copyright (c) 2012 National ICT Australia (NICTA), Australia
 #

data/lib/omf_rc/resource_proxy/virtual_machine_factory.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 #
 # Copyright (c) 2012 National ICT Australia (NICTA), Australia
 #

data/lib/omf_rc/resource_proxy/wlan.rb

@@ -1,15 +1,53 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
+# Proxy module for managing wifi devices
+#
+# Wlan resources can be created as children of {OmfRc::ResourceProxy::Node}.
+#
+# It is important to set if_name (interface_name) and phy (physical device name) as they are used as identifier for executing iw and ip commands.
+#
+# @example Set up a wifi interface wlan0 as managed mode
+#   wlan0 = node.create(:wlan, if_name: 'wlan0', phy: 'phy0')
+#   wlan0.configure_mode(mode: :master, hw_mode: 'g', channel: 1, essid: 'bob')
+#
+# @example Configure IP address of interface wlan0
+#   wlan0.conifgure_ip_addr("192.168.1.100/24")
+#
+# @see OmfRc::Util::Iw
 module OmfRc::ResourceProxy::Wlan
   include OmfRc::ResourceProxyDSL
+  # @!macro extend_dsl
 
   register_proxy :wlan
 
-  utility :ip
-  utility :mod
+  # @!parse include OmfRc::Util::Iw
+  # @!parse include OmfRc::Util::Mod
+  # @!parse include OmfRc::Util::Sysfs
   utility :iw
+  utility :mod
   utility :sysfs
 
+  # @!macro group_prop
+  #
+  # @!attribute [rw] if_name
+  #   Interface name, default is 'wlan0'
+  #   @!macro prop
   property :if_name, :default => "wlan0"
+  # @!attribute [rw] phy
+  #   Device's physical name
+  #   @!macro prop
+  property :phy
+
+  # @!endgroup
 
+  # @!macro group_hook
+  #
+  # Stop hostapd or wpa instances before releasing wifi device
+  # @!macro hook
+  # @!method before_release
   hook :before_release do |device|
     case device.property.mode.to_sym
     when :master
@@ -20,4 +58,5 @@ module OmfRc::ResourceProxy::Wlan
     #TODO need to remove all virtual interfaces of that phy device
     #device.remove_all_interfaces
   end
+  # @!endgroup
 end

data/lib/omf_rc/resource_proxy_dsl.rb

@@ -1,11 +1,30 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 # DSL contains some helper methods to ease the process defining resource proxies
 #
+# DSL methods are defined under {OmfRc::ResourceProxyDSL::ClassMethods}
 module OmfRc::ResourceProxyDSL
+  # Default directory contains proxy definition files
   PROXY_DIR = "omf_rc/resource_proxy"
+  # Default directory contains utility definition files
   UTIL_DIR = "omf_rc/util"
 
-  DEF_ACCESS = [:configure, :request]
+  # Default property access rights through FRCP
+  DEFAULT_PROP_ACCESS = [:configure, :request]
+
+  # Calling a hook within a given resource context
+  #
+  # @param [Symbol] hook_name
+  # @param [Symbol] context in which resource this hook will be called
+  def call_hook(hook_name, context, *params)
+    context.send(hook_name, *params) if context.respond_to? hook_name
+  end
 
+  # When this module included, methods defined under ClassMethods will be available in resource definition files
+  #
   def self.included(base)
     base.extend(ClassMethods)
   end
@@ -123,6 +142,11 @@ module OmfRc::ResourceProxyDSL
       end
     end
 
+    # @see ResourceProxyDSL#call_hook
+    def call_hook(hook_name, context, *params)
+      context.send(hook_name, *params) if context.respond_to? hook_name
+    end
+
     # Include the utility by providing a name
     #
     # The utility file can be added to the default utility directory UTIL_DIR, or defined inline.
@@ -136,6 +160,7 @@ module OmfRc::ResourceProxyDSL
     #     # Simply include this util module
     #     utility :iw
     #   end
+    #
     def utility(name)
       name = name.to_s
       begin
@@ -188,7 +213,6 @@ module OmfRc::ResourceProxyDSL
     #       end
     #     end
     #   end
-    #
     def configure(name, &register_block)
       define_method("configure_#{name.to_s}") do |*args, &block|
         args[0] = Hashie::Mash.new(args[0]) if args[0].class == Hash
@@ -215,6 +239,7 @@ module OmfRc::ResourceProxyDSL
     #       end
     #     end
     #   end
+    #
     def request(name, &register_block)
       define_method("request_#{name.to_s}") do |*args, &block|
         args[0] = Hashie::Mash.new(args[0]) if args[0].class == Hash
@@ -321,29 +346,64 @@ module OmfRc::ResourceProxyDSL
       alias_method "orig_request_#{request_name}", "request_#{request_name}"
     end
 
-    # Define internal property
+    # Define internal property. Refer to options section to see supported options.
+    #
+    # @param [Symbol] name of the property
+    #
+    # @option opts [Object] :default default value of the property
+    # @option opts [Array<Symbol>, Symbol] :access defines access to the property
+    #   it could be defined as an array, listing access rights, which by default is [:configure, :request]
+    #   or it could be defined as one of the predefined symbols :configure, :read_only, or :init_only
+    #
+    # @example
+    #   # Read-only property, i.e. could not be modified through FRCP protocol
+    #   property :bob, default: 1, access: :configure
+    #
+    #   # Read & Write property, i.e. could be modified through FRCP protocol
+    #   property :bob, default: 1, access: :read_only
+    #
+    #   # Read & could be modified ONLY through FRCP CREATE message
+    #   property :bob, default: 1, access: :init_only
     def property(name, opts = {})
       opts = Hashie::Mash.new(opts)
 
-      define_method("def_property_#{name}") do |*args, &block|
+      define_method("default_property_#{name}") do |*args, &block|
         self.property[name] ||= opts[:default]
       end
 
-      access = opts.access || DEF_ACCESS
+      if opts.access.instance_of? Array
+        access = opts.access
+      elsif opts.access.instance_of? Symbol
+        access = case opts.access
+                 when :configure
+                   [:configure, :request]
+                 when :init_only
+                   [:init, :request]
+                 when :read_only
+                   [:request]
+                 else
+                   raise ArgumentError, "Unknown property access mode '#{opts.access}'"
+                 end
+      end
+
+      access ||= DEFAULT_PROP_ACCESS
+
       access.each do |a|
         case a
         when :configure
           define_method("configure_#{name}") do |val|
             self.property[name] = val
           end
-
+        when :init
+          define_method("initialise_#{name}") do |val|
+            self.property[name] = val
+          end
         when :request
           define_method("request_#{name}") do
             self.property[name]
           end
-
         else
-          raise "Unnown access type '#{a}'"
+          raise ArgumentError, "Unnown access type '#{a}'"
         end
       end
     end

data/lib/omf_rc/util/common_tools.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 #
 # Copyright (c) 2012 National ICT Australia (NICTA), Australia
 #

data/lib/omf_rc/util/hostapd.rb

@@ -1,19 +1,30 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 require 'hashie'
 require 'cocaine'
 require 'tempfile'
 
+# Manage Hostapd instances
 module OmfRc::Util::Hostapd
   include OmfRc::ResourceProxyDSL
   include Cocaine
+  # @!macro extend_dsl
 
+  # @!macro group_work
   # Initialise access point conf and pid location
   #
+  # @!method init_ap_conf_pid
   work :init_ap_conf_pid do |device|
     device.property.ap_conf = Tempfile.new(["hostapd.#{device.property.if_name}", ".conf"]).path
     device.property.ap_pid = Tempfile.new(["hostapd.#{device.property.if_name}", ".pid"]).path
   end
+
   # Set up and run a hostapd instance
   #
+  # @!method hostapd
   work :hostapd do |device|
     device.init_ap_conf_pid
 
@@ -35,6 +46,7 @@ module OmfRc::Util::Hostapd
                     :ap_conf => device.property.ap_conf).run
   end
 
+  # @!method stop_hostapd
   work :stop_hostapd do |device|
     begin
       File.open(device.property.ap_pid,'r') do |f|
@@ -50,4 +62,5 @@ module OmfRc::Util::Hostapd
       logger.warn e.message
     end
   end
+  # @!endgroup
 end