apache
feat: add a script to automatically generate doc
What does this PR do?
Add a script to automatically generate doc, Implement the first stage goals mentioned in https://github.com/apache/incubator-fury/issues/1647.
Related issues
https://github.com/apache/incubator-fury/issues/1647
Does this PR introduce any user-facing change?
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
Benchmark
Could we use parse javadoc html instead?
Good suggestion!
It can be implemented by parsing javadoc html. Even if it is implemented by parsing html, we need to clearly point out which config fields are in the comments.
In addition, we need to clearly point out the defaultValue in the comments of each filed, because it will not be included in javadoc. The true default value of the field (for example, false in boolean enable = false will not appear in the javadoc html)
Our config field comments can be designed in the following format?
/**
* xxxxxxxxxxxxx
*
* @defaultValue: xxxx
*/
Do you have any other suggestions for generating Tables based on Fields and writing them to java_serialization_guide.md? @chaokunyang
Hi @chaokunyang , I implemented this function based on parsing javadoc. Could you help review this?