chore(doc): Document code
This commit is contained in:
83
doc/docs/packages/internal/logger.md
Normal file
83
doc/docs/packages/internal/logger.md
Normal file
@@ -0,0 +1,83 @@
|
||||
<!-- Code generated by gomarkdoc. DO NOT EDIT -->
|
||||
|
||||
# logger
|
||||
|
||||
```go
|
||||
import "katenary.io/internal/logger"
|
||||
```
|
||||
|
||||
Package logger provides simple logging functions with icons and colors.
|
||||
|
||||
## func [Failure](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/logger/logger.go#L43>)
|
||||
|
||||
```go
|
||||
func Failure(msg ...any)
|
||||
```
|
||||
|
||||
Failure prints a failure message.
|
||||
|
||||
<a name="Info"></a>
|
||||
## func [Info](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/logger/logger.go#L26>)
|
||||
|
||||
```go
|
||||
func Info(msg ...any)
|
||||
```
|
||||
|
||||
Info prints an informational message.
|
||||
|
||||
<a name="Log"></a>
|
||||
## func [Log](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/logger/logger.go#L49>)
|
||||
|
||||
```go
|
||||
func Log(icon Icon, msg ...any)
|
||||
```
|
||||
|
||||
Log prints a message with a custom icon.
|
||||
|
||||
<a name="Success"></a>
|
||||
## func [Success](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/logger/logger.go#L37>)
|
||||
|
||||
```go
|
||||
func Success(msg ...any)
|
||||
```
|
||||
|
||||
Success prints a success message.
|
||||
|
||||
<a name="Warn"></a>
|
||||
## func [Warn](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/logger/logger.go#L31>)
|
||||
|
||||
```go
|
||||
func Warn(msg ...any)
|
||||
```
|
||||
|
||||
Warn prints a warning message.
|
||||
|
||||
<a name="Icon"></a>
|
||||
## type [Icon](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/logger/logger.go#L5>)
|
||||
|
||||
Icon is a unicode icon
|
||||
|
||||
```go
|
||||
type Icon string
|
||||
```
|
||||
|
||||
<a name="IconSuccess"></a>Icons used in katenary.
|
||||
|
||||
```go
|
||||
const (
|
||||
IconSuccess Icon = "✅"
|
||||
IconFailure Icon = "❌"
|
||||
IconWarning Icon = "❕"
|
||||
IconNote Icon = "📝"
|
||||
IconWorld Icon = "🌐"
|
||||
IconPlug Icon = "🔌"
|
||||
IconPackage Icon = "📦"
|
||||
IconCabinet Icon = "🗄️"
|
||||
IconInfo Icon = "🔵"
|
||||
IconSecret Icon = "🔒"
|
||||
IconConfig Icon = "🔧"
|
||||
IconDependency Icon = "🔗"
|
||||
)
|
||||
```
|
||||
|
||||
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
|
Reference in New Issue
Block a user