Update Debugger documentation

This commit is contained in:
Derek Parker 2015-06-20 17:50:24 -05:00
parent 07473f04c5
commit d265fa764f

@ -9,8 +9,14 @@ import (
"github.com/derekparker/delve/service/api" "github.com/derekparker/delve/service/api"
) )
// Debugger provides a conveniant way to convert from internal // Debugger service.
// structure representations to API representations. //
// Debugger provides a higher level of
// abstraction over proc.DebuggedProcess.
// It handles converting from internal types to
// the types expected by clients. It also handles
// functionality needed by clients, but not needed in
// lower lever packages such as proc.
type Debugger struct { type Debugger struct {
config *Config config *Config
process *proc.DebuggedProcess process *proc.DebuggedProcess
@ -152,12 +158,7 @@ func (d *Debugger) FindThread(id int) *api.Thread {
return nil return nil
} }
// Command handles commands which control the debugger lifecycle. Like other // Command handles commands which control the debugger lifecycle
// debugger operations, these are executed one at a time as part of the
// process operation pipeline.
//
// The one exception is the Halt command, which can be executed concurrently
// with any operation.
func (d *Debugger) Command(command *api.DebuggerCommand) (*api.DebuggerState, error) { func (d *Debugger) Command(command *api.DebuggerCommand) (*api.DebuggerState, error) {
var err error var err error
switch command.Name { switch command.Name {