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.

Sign up for GitHub

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

Jump to bottom

[Doc] Add JavaDoc for eventmesh.runtime.admin APIs (not in dashboard) #4211

Closed
2 tasks done
Pil0tXia opened this issue Jul 10, 2023 · 0 comments · Fixed by #4272
Closed
2 tasks done

[Doc] Add JavaDoc for eventmesh.runtime.admin APIs (not in dashboard) #4211

Pil0tXia opened this issue Jul 10, 2023 · 0 comments · Fixed by #4272
Labels
documentation Improvements or additions to documentation

Comments

@Pil0tXia
Copy link
Member

Pil0tXia commented Jul 10, 2023 •
edited
Loading

Search before asking

  • I had searched in the issues and found no similar issues.

Documentation Related

This is a subtask of GLCC Subject #4040.

Write comments for classes and methods in the org.apache.eventmesh.runtime.admin package which haven't been integrated in the eventmesh-dashboard.

WIP.

Are you willing to submit PR?

  • Yes I am willing to submit a PR!
@Pil0tXia Pil0tXia added the documentation Improvements or additions to documentation label Jul 10, 2023
@Pil0tXia Pil0tXia mentioned this issue Jul 21, 2023
Merged
mxsm pushed a commit that referenced this issue Jul 27, 2023
@Pil0tXia
[ISSUE #4211] Add JavaDoc for eventmesh.runtime.admin APIs (not in da…
81eacbd 
…shboard) (#4272)

* doc: Add JavaDoc for ClientManageController

* doc: Add JavaDoc for HttpHandlerManager

* doc: Add JavaDoc for AbstractHttpHandler

* doc: Add JavaDoc for ConfigurationHandler

* doc: Add JavaDoc for MetricsHandler

* doc: Add JavaDoc for RegistryHandler

* doc: Add JavaDoc for TopicHandler

* doc: Add JavaDoc for EventHandler

* doc: Add JavaDoc for TCPClientHandler

* doc: Add JavaDoc for HTTPClientHandler

* doc: Add JavaDoc for GrpcClientHandler

* doc: Add JavaDoc for HookConfigOperationManager (Outside)

* doc: Add JavaDoc for InsertWebHookConfigHandler

* doc: Add JavaDoc for UpdateWebHookConfigHandler

* doc: Add JavaDoc for DeleteWebHookConfigHandler

* doc: Update JavaDoc for QueryWebHookConfigByIdHandler (WIP)

* Breaking Change: Update JavaDoc for HookConfigOperationManager

* Breaking Change: Update JavaDoc for QueryWebHookConfigByIdHandler

* doc: Update JavaDoc for InsertWebHookConfigHandler

* doc: Update JavaDoc for UpdateWebHookConfigHandler

* doc: Update JavaDoc for DeleteWebHookConfigHandler

* doc: Add JavaDoc for QueryWebHookConfigByManufacturerHandler

* doc: Add JavaDoc for QueryRecommendEventMeshHandler

* doc: Add JavaDoc for RedirectClientByIpPortHandler

* doc: Add JavaDoc for RedirectClientByPathHandler and multiple minor changes

* doc: Add JavaDoc for RedirectClientBySubSystemHandler

* doc: Add JavaDoc for RejectClientByIpPortHandler

* doc: Add JavaDoc for RejectClientBySubSystemHandler

* doc: Add JavaDoc for RejectAllClientHandler

* doc: Add JavaDoc for ShowClientBySystemHandler

* doc: Add JavaDoc for ShowListenClientByTopicHandler and multiple minor changes

* doc: Add JavaDoc for ShowClientHandler and multiple minor changes

* fix: Remove redundant throw and its JavaDoc

* fix: redundant import and formatting

* feat: Streamline and Reduce existing single-line comments

* Optimize: Explain more clearly why HookConfigOperationManager is not used in UpdateWebHookConfigHandler

* Optimze: Explain HookConfigOperationManager more clearly in WebHookConfigOperation

* Optimize: Concise the implement of handle()

* Optimze: Remove some relatively simple comments

* Fix: CI report reference not found
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
1 participant
@Pil0tXia