doc: update package comment for datastructure package

of89013 · Jun 1, 2023 · a8761ee · a8761ee
1 parent cbf8cfd
commit a8761ee
Show file tree

Hide file tree

Showing 14 changed files with 49 additions and 5 deletions.
diff --git a/datastructure/hashmap/hashmap.go b/datastructure/hashmap/hashmap.go
@@ -1,7 +1,7 @@
 // Copyright 2021 [email protected]. All rights reserved.
 // Use of this source code is governed by MIT license
 
-// Package datastructure implements some data structure. eg. list, linklist, stack, queue, tree, graph.
+// Package datastructure implements some data structure. hashmap structure.
 package datastructure
 
 import (

diff --git a/datastructure/heap/maxheap.go b/datastructure/heap/maxheap.go
@@ -1,7 +1,7 @@
 // Copyright 2021 [email protected]. All rights reserved.
 // Use of this source code is governed by MIT license
 
-// Package datastructure implements some data structure. eg. list, linklist, stack, queue, tree, graph.
+// Package datastructure implements some data structure. MaxHeap is a binary max heap.
 package datastructure
 
 import (

diff --git a/datastructure/link/doublylink.go b/datastructure/link/doublylink.go
@@ -1,3 +1,7 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure. Link structure contains SinglyLink and DoublyLink.
 package datastructure
 
 import (

diff --git a/datastructure/link/singlylink.go b/datastructure/link/singlylink.go
@@ -1,3 +1,7 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure. Link structure contains SinglyLink and DoublyLink.
 package datastructure
 
 import (

diff --git a/datastructure/list/list.go b/datastructure/list/list.go
@@ -1,7 +1,7 @@
 // Copyright 2021 [email protected]. All rights reserved.
 // Use of this source code is governed by MIT license
 
-// Package datastructure implements some data structure. eg. list, linklist, stack, queue, tree, graph.
+// Package datastructure contains some data structure. list is a linear table, implemented with slice.
 package datastructure
 
 import (

diff --git a/datastructure/node.go b/datastructure/node.go
@@ -1,7 +1,7 @@
 // Copyright 2021 [email protected]. All rights reserved.
 // Use of this source code is governed by MIT license
 
-// Package datastructure implements some data structure. eg. list, linklist, stack, queue, tree, graph.
+// Package datastructure implements some data structure.
 package datastructure
 
 // LinkNode is a linkedlist node, which have a Value and Pre points to previous node, Next points to a next node of the link.

diff --git a/datastructure/queue/arrayqueue.go b/datastructure/queue/arrayqueue.go
@@ -1,3 +1,8 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure.
+// Queue structure contains ArrayQueue, LinkedQueue, CircularQueue, and PriorityQueue.
 package datastructure
 
 import (

diff --git a/datastructure/queue/circularqueue.go b/datastructure/queue/circularqueue.go
@@ -1,3 +1,8 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure.
+// Queue structure contains ArrayQueue, LinkedQueue, CircularQueue, and PriorityQueue.
 package datastructure
 
 import (

diff --git a/datastructure/queue/linkedqueue.go b/datastructure/queue/linkedqueue.go
@@ -1,3 +1,8 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure.
+// Queue structure contains ArrayQueue, LinkedQueue, CircularQueue, and PriorityQueue.
 package datastructure
 
 import (

diff --git a/datastructure/queue/priorityqueue.go b/datastructure/queue/priorityqueue.go
@@ -1,3 +1,8 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure.
+// Queue structure contains ArrayQueue, LinkedQueue, CircularQueue, and PriorityQueue.
 package datastructure
 
 import (

diff --git a/datastructure/set/set.go b/datastructure/set/set.go
@@ -1,6 +1,10 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure. Set is a data container, like slice, but element of set is not duplicate.
 package datastructure
 
-// Set is a data container, like slice, but element of set is not duplicate
+// Set is a data container, like slice, but element of set is not duplicate.
 type Set[T comparable] map[T]struct{}
 
 // NewSet return a instance of set

diff --git a/datastructure/stack/arraystack.go b/datastructure/stack/arraystack.go
@@ -1,3 +1,7 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure. Stack structure contains ArrayStack and LinkedStack.
 package datastructure
 
 import "errors"

diff --git a/datastructure/stack/linkedstack.go b/datastructure/stack/linkedstack.go
@@ -1,3 +1,7 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure. Stack structure contains ArrayStack and LinkedStack.
 package datastructure
 
 import (

diff --git a/datastructure/tree/bstree.go b/datastructure/tree/bstree.go
@@ -1,3 +1,7 @@
+// Copyright 2021 [email protected]. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package datastructure contains some data structure. BSTree is binary search tree.
 package datastructure
 
 import (