cn.mapway.document.annotation.ApiField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-tools-doc Show documentation

auto gen doc from api with ui

There is a newer version: 3.20.0

/******************************************************************************
 *  *
 *            =============================================================
 *            -   ____ _  _ ____ _  _ ____  _ _ ____ _  _ ____ _  _ ____  -
 *            -    __] |__| |__| |\ | | __  | | |__| |\ | [__  |__| |___  -
 *            -   [___ |  | |  | | \| |__| _| | |  | | \| ___] |  | |___  -
 *            -           http://hi.baidu.com/zhangjianshe                -
 *            =============================================================
 * 
 *******************************************************************************/
package cn.mapway.document.annotation;

import java.lang.annotation.*;

/**
 * API 字段注解.
 *
 * @author zhangjianshe @navinfo.com
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD})
public @interface ApiField {

    /**
     * 描述.
     *
     * @return the string
     */
    String value();

    /**
     * 长度.
     *
     * @return the int
     */
    int length() default 0;

    /**
     * 给出一个字段值得例子.
     *
     * @return the string
     */
    String example() default "";

    /**
     * 是否是强制类型.
     *
     * @return true, if successful
     */
    boolean mandidate() default true;

    /**
     * 字段的排序.
     *
     * @return the int
     */
    int order() default 0;

    /**
     * 引用的HTML文件.
     *
     * @return 引用的文件列表 string [ ]
     */
    String[] refs() default {};

}