Skip to content
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

Merged
merged 10 commits into from
Apr 24, 2024
Merged

Conversation

yvonneyx
Copy link
Contributor

@yvonneyx yvonneyx commented Apr 22, 2024

  • 根据代码注释自动生成【交互、插件】模块对应的 API 文档

BrushSelect 交互:

image

GridLine 插件:

image

@yvonneyx yvonneyx reopened this Apr 23, 2024
@yvonneyx yvonneyx changed the title feat: generate api docs by code annotations feat: generate behavior/plugin api docs by code annotations Apr 23, 2024
/**
* <zh/> 及时框选, 在框选模式为 default 时,才能使用
*
// * TODO fixme
Copy link
Contributor

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.
Copy link
Contributor

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 - 选中的元素状态
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

还有英文注释

export const Theme = { dark, light };
export const Utils = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里之前已经移除了

@@ -1,4 +1,22 @@
export { BaseBehavior, DragCanvas, ZoomCanvas } from './behaviors';
import { dark, light } from './themes';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

可以额外加一个 export for doc。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

@yvonneyx yvonneyx merged commit bfbade2 into v5 Apr 24, 2024
3 of 5 checks passed
@yvonneyx yvonneyx deleted the api-docs branch April 24, 2024 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants