This repository aim to auto-generate the web api document。
- easy to use
- non-invasive for Java source
Meantime , this support to generate the Json source
for export to yapi. It works via the scripts provided also.
There are so many brilliant project for java-api-doc generator,why another project to be done.
The man reason is that i want a easy and non-invasive tool.
@param: the parameter of method@return: the return info
The parameter is necessary or not for current method ;
ethod
The filed or the method will be ignore or not ;
Field,Class,Method,Parameter
In filed:
// line tag
/**
* @ignore
* /
private int number;
// inline tag
/**
* @param {@ignore} {@fuzzy}
*/the name of current entity(contains class,method ) -
Method,class
- Extend the Java doc
- support auto build
- generator html doc
- part generator
dependencies:
-
git hook