Commenting

irmaclient/client.go

@@ -17,6 +17,14 @@ import (
 // This file contains most methods of the Client (c.f. session.go
 // and updates.go).
 //
+// Clients are the main entry point into this package for the user of this package.
+// The Client struct:
+// - (De)serializes credentials and keyshare server information
+// from storage, as well as logs of earlier IRMA sessions
+// - it provides access to the attributes and all related information of its credentials,
+// - it is the starting point for new IRMA sessions;
+// - and it computes some of the messages in the client side of the IRMA protocol.
+//
 // The storage of credentials is split up in several parts:
 //
 // - The CL-signature of each credential is stored separately, so that we can
@@ -30,11 +38,6 @@ import (
 // across all credentials, is stored only once in a separate file (storing this
 // in multiple places would be bad).
 
-// Client (de)serializes credentials and keyshare server information
-// from storage; as well as logs of earlier IRMA sessions; it provides access
-// to the attributes and all related information of its credentials;
-// it is the starting point for new IRMA sessions; and it computes some
-// of the messages in the client side of the IRMA protocol.
 type Client struct {
 	// Stuff we manage on disk
 	secretkey        *secretKey

irmaclient/session.go

@@ -14,8 +14,9 @@ import (
 	"github.com/privacybydesign/irmago"
 )
 
-// This file contains the client side of the IRMA protocol, as well as the Handler interface
-// which is used to communicate session info with the user.
+// This file contains the logic and state of performing IRMA sessions, communicates
+// with IRMA API servers, and uses the calling Client to construct messages and replies
+// in the IRMA protocol.
 
 // PermissionHandler is a callback for providing permission for an IRMA session
 // and specifying the attributes to be disclosed.