Garyelephant.fea.plugin docs

[garyelephant]

Plugin document自动生成功能：

功能描述：根据plugin开发者定义的*.docs文件，自动生成markdown文件

优点：

• plugin document 定义方式相同，展现格式统一，可程序解析。

示例：执行命令：

sbt "run-main org.interestinglab.waterdrop.docutils.PluginDocCommand src/main/antlr4/PluginDocExample.docs"

PluginDocExample.docs内容：

@waterdropPlugin
@pluginGroup input
@pluginName kafka
@pluginDesc "get message from kafka"
@pluginAuthor garyelephant
@pluginHomepage https://interestinglab.github.io/waterdrop
@pluginVersion 1.2.3

@pluginOption array topics yes "a list of topics to consume"
@pluginOption string consumer.bootstrap.servers yes "kafka broker list"
@pluginOption string consumer.group.id yes "consumer group id"
@pluginOption number consumer.num.consumer.fetchers="2" no

---

输出如下markdown内容：

input plugin : kafka

• Author: garyelephant
• Homepage: https://interestinglab.github.io/waterdrop
• Version: 1.2.3

Description

get message from kafka

Options

name	type	required	default value
consumer.bootstrap.servers	string	yes	-
consumer.group.id	string	yes	-
consumer.num.consumer.fetchers	number	no	2
topics	array	yes	-

consumer.bootstrap.servers [string]

kafka broker list

consumer.group.id [string]

consumer group id

consumer.num.consumer.fetchers [number]

topics [array]

a list of topics to consume