docs: 优化文档展示,适配部分无目录文档,适配非结构体的类型定义,增加测试用例文档
This commit is contained in:
@@ -1,44 +1,49 @@
|
||||
# Deck
|
||||
|
||||
deck 包中的内容用于针对一堆内容的管理,适用但不限于牌堆、麻将牌堆等情况。
|
||||
|
||||
[](https://pkg.go.dev/github.com/kercylan98/minotaur/deck)
|
||||

|
||||
|
||||
## 目录
|
||||
列出了该 `package` 下所有的函数,可通过目录进行快捷跳转 ❤️
|
||||
deck 包中的内容用于针对一堆内容的管理,适用但不限于牌堆、麻将牌堆等情况。
|
||||
|
||||
|
||||
## 目录导航
|
||||
列出了该 `package` 下所有的函数及类型定义,可通过目录导航进行快捷跳转 ❤️
|
||||
<details>
|
||||
<summary>展开 / 折叠目录</summary
|
||||
<summary>展开 / 折叠目录导航</summary>
|
||||
|
||||
|
||||
> 包级函数定义
|
||||
|
||||
|函数|描述
|
||||
|函数名称|描述
|
||||
|:--|:--
|
||||
|[NewDeck](#NewDeck)|创建一个新的甲板
|
||||
|[NewGroup](#NewGroup)|创建一个新的组
|
||||
|
||||
|
||||
> 结构体定义
|
||||
> 类型定义
|
||||
|
||||
|结构体|描述
|
||||
|:--|:--
|
||||
|[Deck](#deck)|甲板,用于针对一堆 Group 进行管理的数据结构
|
||||
|[Group](#group)|甲板中的组,用于针对一堆内容进行管理的数据结构
|
||||
|[Item](#item)|甲板成员
|
||||
|类型|名称|描述
|
||||
|:--|:--|:--
|
||||
|`STRUCT`|[Deck](#deck)|甲板,用于针对一堆 Group 进行管理的数据结构
|
||||
|`STRUCT`|[Group](#group)|甲板中的组,用于针对一堆内容进行管理的数据结构
|
||||
|`INTERFACE`|[Item](#item)|甲板成员
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
***
|
||||
## 详情信息
|
||||
#### func NewDeck() *Deck[I]
|
||||
<span id="NewDeck"></span>
|
||||
> 创建一个新的甲板
|
||||
|
||||
***
|
||||
#### func NewGroup(guid int64, fillHandle func (guid int64) []I) *Group[I]
|
||||
<span id="NewGroup"></span>
|
||||
> 创建一个新的组
|
||||
|
||||
***
|
||||
### Deck
|
||||
### Deck `STRUCT`
|
||||
甲板,用于针对一堆 Group 进行管理的数据结构
|
||||
```go
|
||||
type Deck[I Item] struct {
|
||||
@@ -67,7 +72,7 @@ type Deck[I Item] struct {
|
||||
#### func (*Deck) GetPrev(guid int64) *Group[I]
|
||||
> 获取特定组的上一个组
|
||||
***
|
||||
### Group
|
||||
### Group `STRUCT`
|
||||
甲板中的组,用于针对一堆内容进行管理的数据结构
|
||||
```go
|
||||
type Group[I Item] struct {
|
||||
@@ -121,8 +126,8 @@ type Group[I Item] struct {
|
||||
#### func (*Group) GetItem(index int) I
|
||||
> 获取组中的指定内容
|
||||
***
|
||||
### Item
|
||||
### Item `INTERFACE`
|
||||
甲板成员
|
||||
```go
|
||||
type Item struct{}
|
||||
type Item interface{}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user