Dialect

库类型

为提高接口文档的可读性以及文档的生成速度，有时我们需要忽略一些参数类型的源码结构和注释，让smalldoc不去解析它。通常，这些类是我们耳熟能详的。smalldoc默认包含的库类型如下：

• 八大基本类型，以及他们的包装类型
• java.包下的所有类，例如java.lang.String、java.math.BigDecimal
• javax.包下的所有类，例如javax.servlet.http.HttpServletRequest、javax.servlet.http.HttpServletResponse
• org.springframework.包下的所有类，例如org.springframework.web.multipart.MultipartFile、org.springframework.web.multipart.MultipartRequest

特殊的，我们可以使用属性smalldoc.library-type-qualified-names或smalldoc.library-type-packages来增加额外的库类型，详情可见 属性附录...

实体类型

不是库类型就是实体类型。

实体字段

实体类型的字段，都称为实体字段

非实体字段

库类型的字段，都称为非实体字段

继承字段

继承于父类或祖先类的字段都称为继承字段

非继承字段

在当前类中直接声明的字段都成为非继承字段

文档化类

需要生成文档的类，通常是指定义API接口的Controller类。如果这部分类没有在source-paths给出的默认路径中包含，那么你需要把包含这些类的目录的绝对路径，使用source-paths指定。详情可见 属性附录...

非文档化类

有些类，并不需要生成文档，但是它们可能是声明API接口的参数，返回值，甚至是注解的类，大多数时候我们需要它们包含在源码中的注释信息用来丰富文档的内容。同样的，像 文档化类 一样，如果这部分类没有在source-paths给出的默认路径中包含，那么你需要把包含这些类的目录的绝对路径，使用source-paths指定。详情可见 属性附录...