add a few package docs

Signed-off-by: Merlin Ran <[email protected]>

api/service.go

@@ -1,3 +1,4 @@
+// Package api is all about the DB API. It contains the protobuf definition (under /pb), a Go client (under /client) and a gRPC service for the API backed by the actual DB manager.
 package api
 
 import (
@@ -27,7 +28,7 @@ var (
 	log = logging.Logger("threadsapi")
 )
 
-// Service is a gRPC service for a DB manager.
+// Service is a gRPC DB API service backed by a DB manager.
 type Service struct {
 	manager *db.Manager
 }
@@ -61,6 +62,7 @@ func (s *Service) Close() error {
 	return s.manager.Close()
 }
 
+// remoteIdentity implements core.thread.Identify.
 type remoteIdentity struct {
 	pk     thread.PubKey
 	server pb.API_GetTokenServer

cbor/record.go

@@ -1,3 +1,4 @@
+// Package cbor provides utilities to create or convert data to and from CBOR format (https://cbor.io/).
 package cbor
 
 import (
@@ -142,7 +143,7 @@ func RecordToProto(ctx context.Context, dag format.DAGService, rec net.Record) (
 	}, nil
 }
 
-// Unmarshal returns a node from a serialized version that contains link data.
+// RecordFromProto returns a node from a serialized version that contains link data.
 func RecordFromProto(rec *pb.Log_Record, key crypto.DecryptionKey) (net.Record, error) {
 	if key == nil {
 		return nil, fmt.Errorf("decryption key is required")

common/common.go

@@ -1,3 +1,4 @@
+// Package common provides utilities to set network options.
 package common
 
 import (

core/doc.go

@@ -0,0 +1,2 @@
+// Package core defines the core types, constants, data structures and interfaces for go-threads.
+package core

logstore/logstore.go

@@ -1,3 +1,4 @@
+//Package logstore provides local store for thread logs. The subpackages provide creators for different types of store implementations.
 package logstore
 
 import (

net/api/service.go

@@ -1,3 +1,4 @@
+// Package api is all about the Network API. It contains the protobuf definition (under /pb), a Go client (under /client) and a gRPC service for the API backed by the threads network.
 package api
 
 import (

net/net.go

@@ -1,3 +1,4 @@
+//Package net implements the network layer for go-threads. Nodes exchange messages with each other via gRPC, and the format is defined under /pb.
 package net
 
 import (
@@ -87,7 +88,7 @@ func (t semaThreadUpdate) Key() string {
 	return "tu:" + string(t)
 }
 
-// net is an implementation of core.DBNet.
+// net is an implementation of app.Net.
 type net struct {
 	format.DAGService
 	host   host.Host