diff --git a/README.md b/README.md index fad742a..eec8d28 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ + +

AtomicGo | stack

@@ -16,7 +33,7 @@ -Unit test count +Unit test count @@ -107,8 +124,7 @@ func New[T any]() Stack[T] New returns a new stack. -

Example -

+ @@ -124,8 +140,7 @@ func main() { } ``` -

-
+ ### func \(\*Stack\[T\]\) [Clear]() @@ -136,8 +151,7 @@ func (s *Stack[T]) Clear() Clear removes all items from the stack. -
Example -

+ @@ -168,8 +182,7 @@ func main() { [] ``` -

-
+ ### func \(\*Stack\[T\]\) [Contains]() @@ -180,8 +193,7 @@ func (s *Stack[T]) Contains(item T) bool Contains returns true if the stack contains the item. -
Example -

+ @@ -212,8 +224,7 @@ true false ``` -

-
+ ### func \(\*Stack\[T\]\) [IsEmpty]() @@ -224,8 +235,7 @@ func (s *Stack[T]) IsEmpty() bool IsEmpty returns true if the stack is empty. -
Example -

+ @@ -259,8 +269,7 @@ false true ``` -

-
+ ### func \(\*Stack\[T\]\) [Peek]() @@ -280,8 +289,7 @@ func (s *Stack[T]) Pop() T Pop removes an item from the stack and returns it. Panics if the stack is empty. Use PopSafe for safer access to the Stack. -
Example -

+ @@ -312,8 +320,7 @@ World Hello ``` -

-
+ ### func \(\*Stack\[T\]\) [PopSafe]() @@ -324,8 +331,7 @@ func (s *Stack[T]) PopSafe() T PopSafe removes an item from the stack and returns it. Returns the zero value of the type if the stack is empty. To make this function safe, it uses reflection and is therefore slower than Pop. -
Example -

+ @@ -357,8 +363,7 @@ World Hello ``` -

-
+ ### func \(\*Stack\[T\]\) [Push]() @@ -369,8 +374,7 @@ func (s *Stack[T]) Push(item ...T) Push adds items to a stack. -
Example -

+ @@ -399,8 +403,7 @@ func main() { [Hello World] ``` -

-
+ ### func \(\*Stack\[T\]\) [Size]() @@ -411,8 +414,7 @@ func (s *Stack[T]) Size() int Size returns the size of the stack. -
Example -

+ @@ -441,8 +443,7 @@ func main() { 2 ``` -

-
+ ### func \(Stack\[T\]\) [String]() @@ -453,8 +454,7 @@ func (s Stack[T]) String() string -
Example -

+ @@ -483,8 +483,7 @@ func main() { [Hello World] ``` -

-
+ ### func \(\*Stack\[T\]\) [Values]() @@ -495,8 +494,7 @@ func (s *Stack[T]) Values() []T Values returns the values of the stack as a slice. -
Example -

+ @@ -525,8 +523,7 @@ func main() { [Hello World] ``` -

-
+ Generated by [gomarkdoc]()