方法添加注释,中文版注释

This commit is contained in:
rainyan
2020-04-05 22:23:17 +08:00
parent c755120c8d
commit 13c30d4c55
27 changed files with 457 additions and 150 deletions

View File

@@ -27,6 +27,11 @@ type Meta struct {
Icon string `json:"icon"`
}
// @title AddBaseMenu
// @description 函数的详细描述
// @auth 2020/04/05 20:22
// @param newPassword string
// @return err error
//增加基础路由
func (b *SysBaseMenu) AddBaseMenu() (err error) {
findOne := global.GVA_DB.Where("name = ?", b.Name).Find(&SysBaseMenu{}).Error
@@ -39,7 +44,11 @@ func (b *SysBaseMenu) AddBaseMenu() (err error) {
return err
}
//删除基础路由
// @title DeleteBaseMenu
// @description 删除基础路由
// @auth 2020/04/05 20:22
// @param newPassword string
// @return err error
func (b *SysBaseMenu) DeleteBaseMenu(id float64) (err error) {
err = global.GVA_DB.Where("parent_id = ?", id).First(&SysBaseMenu{}).Error
if err != nil {
@@ -51,7 +60,11 @@ func (b *SysBaseMenu) DeleteBaseMenu(id float64) (err error) {
return err
}
//更新路由
// @title UpdateBaseMenu
// @description 更新路由
// @auth 2020/04/05 20:22
// @param newPassword string
// @return err error
func (b *SysBaseMenu) UpdateBaseMenu() (err error) {
upDateMap := make(map[string]interface{})
upDateMap["parent_id"] = b.ParentId
@@ -69,13 +82,21 @@ func (b *SysBaseMenu) UpdateBaseMenu() (err error) {
return err
}
//当前选中角色所拥有的路由
// @title GetBaseMenuById
// @description 当前选中角色所拥有的路由
// @auth 2020/04/05 20:22
// @param newPassword string
// @return err error
func (b *SysBaseMenu) GetBaseMenuById(id float64) (err error, menu SysBaseMenu) {
err = global.GVA_DB.Where("id = ?", id).First(&menu).Error
return
}
//获取路由分页
// @title GetInfoList
// @description 获取路由分页
// @auth 2020/04/05 20:22
// @param newPassword string
// @return err error
func (b *SysBaseMenu) GetInfoList(info PageInfo) (err error, list interface{}, total int) {
limit := info.PageSize
offset := info.PageSize * (info.Page - 1)
@@ -92,7 +113,11 @@ func (b *SysBaseMenu) GetInfoList(info PageInfo) (err error, list interface{}, t
}
}
//获取基础路由树
// @title GetBaseMenuTree
// @description 获取基础路由树
// @auth 2020/04/05 20:22
// @return err error
// @return menus []SysBaseMenu
func (m *SysBaseMenu) GetBaseMenuTree() (err error, menus []SysBaseMenu) {
err = global.GVA_DB.Where(" parent_id = ?", 0).Order("sort", true).Find(&menus).Error
for i := 0; i < len(menus); i++ {
@@ -101,6 +126,11 @@ func (m *SysBaseMenu) GetBaseMenuTree() (err error, menus []SysBaseMenu) {
return err, menus
}
// @title getBaseChildrenList
// @description get children of menu, 获取菜单的子菜单
// @auth 2020/04/05 20:22
// @param menu *SysBaseMenu
// @return err error
func getBaseChildrenList(menu *SysBaseMenu) (err error) {
err = global.GVA_DB.Where("parent_id = ?", menu.ID).Order("sort", true).Find(&menu.Children).Error
for i := 0; i < len(menu.Children); i++ {