Add documentation

bindings/follow.go

@@ -106,6 +106,7 @@ func (c *Cmix) ReadyToSend() bool {
 // is to being ready.
 //
 // Example JSON:
+//
 //	{
 //	  "IsReady": true,
 //	  "HowClose": 0.534
@@ -117,6 +118,7 @@ type IsReadyInfo struct {
 
 // NetworkFollowerStatus gets the state of the network follower. It returns a
 // status with the following values:
+//
 //	Stopped  - 0
 //	Running  - 2000
 //	Stopping - 3000
@@ -215,6 +217,7 @@ func (c *Cmix) IsHealthy() bool {
 //   - []byte - A JSON marshalled list of all running processes.
 //
 // JSON Example:
+//
 //	{
 //	  "FileTransfer{BatchBuilderThread, FilePartSendingThread#0, FilePartSendingThread#1, FilePartSendingThread#2, FilePartSendingThread#3}",
 //	  "MessageReception Worker 0"
@@ -267,6 +270,7 @@ func (c *Cmix) RegisterClientErrorCallback(clientError ClientError) {
 //   - err - JSON unmarshalling error
 //
 // Example JSON:
+//
 //	[
 //	  {
 //	    "Id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD", // bytes of id.ID encoded as base64 string
@@ -296,7 +300,10 @@ type TrackServicesCallback interface {
 // TrackServices will return via a callback the list of services the
 // backend keeps track of, which is formally referred to as a
 // [message.ServiceList]. This may be passed into other bindings call which
-// may need context on the available services for this client.
+// may need context on the available services for this client. This is the equivalent
+// of GetPreimages in APIv0. The callback will be called every time a new service
+// is added or an existing service is deleted. This serves as a way for
+// the caller to have the most up-to-date list of existing services.
 //
 // Parameters:
 //   - cb - A TrackServicesCallback, which will be passed the marshalled

bindings/notifications.go

@@ -17,6 +17,7 @@ import (
 // via GetNotificationsReport as a JSON marshalled byte data.
 //
 // Example JSON:
+//
 //	[
 //	  {
 //	    "ForMe": true,                                           // boolean
@@ -44,6 +45,7 @@ type NotificationReports []NotificationReport
 // this user.
 //
 // Example NotificationReport JSON:
+//
 //	{
 //	  "ForMe": true,
 //	  "Type": "e2e",
@@ -84,7 +86,8 @@ type NotificationReport struct {
 //   - notificationCSV - the notification data received from the
 //     notifications' server.
 //   - marshalledServices - the JSON-marshalled list of services the backend
-//    keeps track of. Refer to Cmix.TrackServices for information about this.
+//     keeps track of. Refer to Cmix.TrackServices for information about this. This
+//     is the equivalent to preimages in APIv0.
 //
 // Returns:
 //   - []byte - A JSON marshalled NotificationReports. Some NotificationReport's