feat: add a script to automatically generate doc #1648
Conversation
Signed-off-by: LiangliangSui <[email protected]>
LiangliangSui
requested review from
chaokunyang,
theweipeng and
PragmaTwice
as code owners
|
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, Our config field comments can be designed in the following format? |
|
Do you have any other suggestions for generating Tables based on Fields and writing them to |
Signed-off-by: LiangliangSui <[email protected]>
Signed-off-by: LiangliangSui <[email protected]>
Signed-off-by: LiangliangSui <[email protected]>
|
Demo
|
|
Hi @chaokunyang , I implemented this function based on parsing javadoc. Could you help review this? |
Signed-off-by: LiangliangSui <[email protected]>
| </li> | ||
| </ul> | ||
| """ | ||
| tag_labels = field.xpath('li/dl/dt/span[@class="simpleTagLabel"]/text()') |
There was a problem hiding this comment.
This seems coupled with javadoc structure. WIll javadoc generated html change between JDK vendor and different JDK versions?
There was a problem hiding this comment.
Yes, we may be able to automatically install the fixed version and vendor in the script before generating javadoc.
Or do you have any other good ideas?
What does this PR do?
Add a script to automatically generate doc, Implement the first stage goals mentioned in #1647.
Related issues
#1647
Does this PR introduce any user-facing change?
Benchmark