fix(lint): add comments.

Signed-off-by: Bo-Yi Wu <[email protected]>

Author: appleboy

consumer.go

@@ -13,7 +13,7 @@ var _ Worker = (*Consumer)(nil)
 
 var errMaxCapacity = errors.New("max capacity reached")
 
-// Worker for simple queue using channel
+// Consumer for simple queue using channel
 type Consumer struct {
 	taskQueue chan QueuedMessage
 	runFunc   func(context.Context, QueuedMessage) error
@@ -32,6 +32,7 @@ func (s *Consumer) decBusyWorker() {
 	s.metric.DecBusyWorker()
 }
 
+// BusyWorkers returns the numbers of workers has been busy.
 func (s *Consumer) BusyWorkers() uint64 {
 	return s.metric.BusyWorkers()
 }

options.go

@@ -67,6 +67,7 @@ func WithTimeOut(t time.Duration) Option {
 	}
 }
 
+// Options for custom args in Queue
 type Options struct {
 	workerCount int
 	timeout     time.Duration
@@ -77,6 +78,7 @@ type Options struct {
 	metric      Metric
 }
 
+// NewOptions initialize the default value for the options
 func NewOptions(opts ...Option) *Options {
 	o := &Options{
 		workerCount: defaultWorkerCount,

pool.go

@@ -1,5 +1,6 @@
 package queue
 
+// NewPool initializes a new pool
 func NewPool(size int, opts ...Option) *Queue {
 	o := []Option{
 		WithWorkerCount(size),

queue.go

@@ -47,6 +47,7 @@ func (j Job) Bytes() []byte {
 	return j.Payload
 }
 
+// Encode for encoding the structure
 func (j Job) Encode() []byte {
 	b, _ := json.Marshal(j)
 	return b
@@ -107,7 +108,7 @@ func (q *Queue) Shutdown() {
 	})
 }
 
-// Workers returns the numbers of workers has been created.
+// Release for graceful shutdown.
 func (q *Queue) Release() {
 	q.Shutdown()
 	q.Wait()
@@ -143,7 +144,7 @@ func (q *Queue) Queue(job QueuedMessage) error {
 	return q.handleQueue(q.timeout, job)
 }
 
-// Queue to queue all job
+// QueueWithTimeout to queue all job with specified timeout.
 func (q *Queue) QueueWithTimeout(timeout time.Duration, job QueuedMessage) error {
 	return q.handleQueue(timeout, job)
 }