diff options
author | Michael Steinert <[email protected]> | 2015-03-30 19:16:13 -0500 |
---|---|---|
committer | Michael Steinert <[email protected]> | 2015-03-30 19:16:13 -0500 |
commit | 767cadc80c3aab98a79b9177e3ec762dfaa637e4 (patch) | |
tree | 12f0c25a0c0ec9b937f8770d2e37cf49c48a8e4c /transaction.go | |
parent | 8fad6141759baefd2eb2a328cfd573996df3e2cf (diff) |
Small documentation updates
Diffstat (limited to 'transaction.go')
-rw-r--r-- | transaction.go | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/transaction.go b/transaction.go index e6e8d4c..13d90dc 100644 --- a/transaction.go +++ b/transaction.go @@ -45,7 +45,7 @@ type Conversation struct { } // Constructs a new conversation object with a given handler and a newly -// allocated pam_conv struct that uses this object as its appdata_ptr +// allocated pam_conv struct that uses this object as its appdata_ptr. func NewConversation(handler ConversationHandler) (*Conversation, C.int) { c := &Conversation{} c.handler = handler @@ -82,14 +82,11 @@ func TransactionFinalizer(t *Transaction) { C.free(unsafe.Pointer(t.conv.conv)) } -// Start initiates a new PAM transaction. service is treated identically +// Start initiates a new PAM transaction. Service is treated identically // to how pam_start treats it internally. // // All application calls to PAM begin with Start(). The returned *Transaction // provides an interface to the remainder of the API. -// -// The returned status int may be ABORT, BUF_ERR, SUCCESS, or SYSTEM_ERR, as per -// the official PAM documentation. func Start(service, user string, handler ConversationHandler) (*Transaction, error) { t := &Transaction{} t.conv, t.status = NewConversation(handler) |