-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: generate behavior/plugin api docs by code annotations #5669
Conversation
/** | ||
* <zh/> 及时框选, 在框选模式为 default 时,才能使用 | ||
* | ||
// * TODO fixme |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里修正下注释?
/** | ||
* <zh/> 及时框选, 在框选模式为 default 时,才能使用 | ||
* | ||
// * TODO fixme | ||
* <en/> Timely screening. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里也是
@@ -80,6 +91,8 @@ export interface BrushSelectOptions extends BaseBehaviorOptions { | |||
* <zh/> 框选元素状态回调。 | |||
* | |||
* <en/> Callback when brush select elements. | |||
* @param states - 选中的元素状态 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
还有英文注释
packages/g6/src/exports.ts
Outdated
export const Theme = { dark, light }; | ||
export const Utils = { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里之前已经移除了
packages/g6/src/exports.ts
Outdated
@@ -1,4 +1,22 @@ | |||
export { BaseBehavior, DragCanvas, ZoomCanvas } from './behaviors'; | |||
import { dark, light } from './themes'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
可以额外加一个 export for doc。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👌
BrushSelect 交互:
GridLine 插件: