docs: 注释调整

This commit is contained in:
haoxr 2022-12-24 12:24:12 +08:00
parent 00d7febcf1
commit b2a0dfabb8
8 changed files with 38 additions and 45 deletions

View File

@ -1,12 +1,13 @@
package com.youlai.mall.oms.enums; package com.youlai.mall.oms.common.enums;
import com.youlai.common.base.IBaseEnum; import com.youlai.common.base.IBaseEnum;
import lombok.Getter; import lombok.Getter;
/** /**
* 订单支付类型枚举
*
* @author huawei * @author huawei
* @desc 订单支付类型枚举
* @email huawei_code@163.com * @email huawei_code@163.com
* @date 2021/1/16 * @date 2021/1/16
*/ */

View File

@ -3,7 +3,7 @@ package com.youlai.mall.oms.controller.app;
import com.youlai.common.result.Result; import com.youlai.common.result.Result;
import com.youlai.common.security.util.SecurityUtils; import com.youlai.common.security.util.SecurityUtils;
import com.youlai.mall.oms.pojo.dto.CartItemDTO; import com.youlai.mall.oms.pojo.dto.CartItemDTO;
import com.youlai.mall.oms.service.ICartService; import com.youlai.mall.oms.service.CartService;
import io.swagger.annotations.Api; import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam; import io.swagger.annotations.ApiParam;
@ -13,18 +13,20 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/** /**
* 移动端购物车接口
*
* @author huawei * @author huawei
* @email huawei_code@163.com * @email huawei_code@163.com
* @date 2020-12-30 22:31:10 * @date 2020-12-30 22:31:10
*/ */
@Api(tags = "「移动端」购物车管理") @Api(tags = "「移动端」购物车接口")
@RestController @RestController
@RequestMapping("/app-api/v1/carts") @RequestMapping("/app-api/v1/carts")
@RequiredArgsConstructor @RequiredArgsConstructor
public class CartController { public class CartController {
private final ICartService cartService; private final CartService cartService;
@ApiOperation(value = "查询购物车") @ApiOperation(value = "查询购物车")
@GetMapping @GetMapping

View File

@ -3,7 +3,10 @@ package com.youlai.mall.oms.pojo.dto;
import lombok.*; import lombok.*;
/** /**
* 订单商品明细 * 订单商品
*
* @author haoxr
* @date 2022/12/21
*/ */
@Data @Data
public class OrderItemDTO { public class OrderItemDTO {

View File

@ -1,8 +1,11 @@
package com.youlai.mall.oms.pojo.form; package com.youlai.mall.oms.pojo.form;
import com.youlai.mall.oms.common.enums.OrderSourceTypeEnum;
import com.youlai.mall.oms.pojo.dto.OrderItemDTO; import com.youlai.mall.oms.pojo.dto.OrderItemDTO;
import com.youlai.mall.ums.dto.MemberAddressDTO; import com.youlai.mall.ums.dto.MemberAddressDTO;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data; import lombok.Data;
import lombok.ToString;
import javax.validation.constraints.Size; import javax.validation.constraints.Size;
import java.util.List; import java.util.List;
@ -15,42 +18,38 @@ import java.util.List;
* @date 2021/1/16 * @date 2021/1/16
*/ */
@Data @Data
@ToString
public class OrderSubmitForm { public class OrderSubmitForm {
/** /**
* 提交订单确认页面签发的令牌 * 订单来源
*
* @see OrderSourceTypeEnum
*/ */
@ApiModelProperty("订单来源")
private Integer sourceType;
@ApiModelProperty("提交订单确认页面签发的令牌(防止订单重复提交,订单提交成功转为订单编号)")
private String orderToken; private String orderToken;
/** @ApiModelProperty("订单总金额-用于验价(单位:分)")
* 订单总金额-用于验价(单位)
*/
private Long totalAmount; private Long totalAmount;
/** @ApiModelProperty("支付金额(单位:分)")
* 支付金额(单位)
*/
private Long payAmount; private Long payAmount;
/** @ApiModelProperty("订单的商品明细")
* 订单的商品明细
*/
private List<OrderItemDTO> orderItems; private List<OrderItemDTO> orderItems;
/** @ApiModelProperty("订单备注")
* 订单备注
*/
@Size(max = 500, message = "订单备注长度不能超过500") @Size(max = 500, message = "订单备注长度不能超过500")
private String remark; private String remark;
/** @ApiModelProperty("优惠券ID")
* 优惠券ID
*/
private String couponId; private String couponId;
/** @ApiModelProperty("收获地址")
* 收获地址
*/
private MemberAddressDTO deliveryAddress; private MemberAddressDTO deliveryAddress;
} }

View File

@ -1,4 +1,4 @@
package com.youlai.mall.pms.util; package com.youlai.mall.pms.common.util;
import com.google.common.hash.Funnel; import com.google.common.hash.Funnel;
import com.google.common.hash.Hashing; import com.google.common.hash.Hashing;
@ -6,10 +6,10 @@ import com.google.common.hash.Hashing;
import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkArgument;
/** /**
* 布隆过滤器摘录自Google-guava包
*
* @author DaniR * @author DaniR
* @version 1.0 * @date 2021/6/23 20:30
* @description 布隆过滤器摘录自Google-guava包
* @createDate 2021/6/23 20:30
*/ */
public class BloomFilterUtils<T> { public class BloomFilterUtils<T> {
private final int numHashFunctions; private final int numHashFunctions;

View File

@ -2,7 +2,7 @@ package com.youlai.mall.pms.controller.app;
import com.youlai.common.result.Result; import com.youlai.common.result.Result;
import com.youlai.mall.pms.pojo.vo.CategoryVO; import com.youlai.mall.pms.pojo.vo.CategoryVO;
import com.youlai.mall.pms.service.IPmsCategoryService; import com.youlai.mall.pms.service.CategoryService;
import io.swagger.annotations.Api; import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam; import io.swagger.annotations.ApiParam;
@ -16,7 +16,7 @@ import java.util.List;
/** /**
* 商品分类控制器 * 商品分类控制器
* *
* @author <a href="mailto:xianrui0365@163.com">haoxr</a> * @author haoxr
* @date 2022/2/5 * @date 2022/2/5
*/ */
@Api(tags = "「移动端」商品分类") @Api(tags = "「移动端」商品分类")
@ -25,13 +25,13 @@ import java.util.List;
@RequiredArgsConstructor @RequiredArgsConstructor
public class CategoryController { public class CategoryController {
private final IPmsCategoryService iPmsCategoryService; private final CategoryService categoryService;
@ApiOperation(value = "分类列表") @ApiOperation(value = "分类列表")
@GetMapping @GetMapping
public Result list( public Result list(
@ApiParam("上级分类ID") Long parentId) { @ApiParam("上级分类ID") Long parentId) {
List<CategoryVO> list = iPmsCategoryService.listCategory(parentId); List<CategoryVO> list = categoryService.listCategory(parentId);
return Result.success(list); return Result.success(list);
} }
} }

View File

@ -4,13 +4,7 @@ import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.youlai.mall.pms.pojo.entity.PmsCategoryAttribute; import com.youlai.mall.pms.pojo.entity.PmsCategoryAttribute;
import org.apache.ibatis.annotations.Mapper; import org.apache.ibatis.annotations.Mapper;
/**
* @author haoxr
* @date 2020-11-06
*/
@Mapper @Mapper
public interface PmsCategoryAttributeMapper extends BaseMapper<PmsCategoryAttribute> { public interface PmsCategoryAttributeMapper extends BaseMapper<PmsCategoryAttribute> {
} }

View File

@ -10,12 +10,6 @@ import org.apache.ibatis.annotations.Mapper;
import java.util.List; import java.util.List;
/**
* 商品持久层
*
* @author <a href="mailto:xianrui0365@163.com">haoxr</a>
* @date 2022/2/5
*/
@Mapper @Mapper
public interface PmsSpuMapper extends BaseMapper<PmsSpu> { public interface PmsSpuMapper extends BaseMapper<PmsSpu> {