lib/twib/interfaces/ITwibDeviceInterface.rb in twib-0.1.0 vs lib/twib/interfaces/ITwibDeviceInterface.rb in twib-0.1.1

@@ -2,11 +2,13 @@
 
 require "twib/interfaces/ITwibDebugger.rb"
 
 module Twib
   module Interfaces
+    # Main interface exposed by a device.
     class ITwibDeviceInterface < Interface
+      # @api private
       module Command
         RUN = 10
         REBOOT = 11
         COREDUMP = 12
         TERMINATE = 13
@@ -15,9 +17,13 @@
         IDENTIFY = 16
         LIST_NAMED_PIPES = 17
         OPEN_NAMED_PIPE = 18
         OPEN_ACTIVE_DEBUGGER = 19
       end
+
+      # Opens an active debugger for the process with the given PID.
+      # @param pid [Integer] Process ID
+      # @return [ITwibDebugger] Debugger interface
       def open_active_debugger(pid)
         ITwibDebugger.new(@connection, @device_id, send(Command::OPEN_ACTIVE_DEBUGGER, [pid].pack("Q<")).wait_ok.object_ids[0])
       end
     end
   end