Skip to content

[ISSUE #4208] Add JavaDoc for org.apache.eventmesh.runtime.admin APIs of dashboard #4210

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
Merged
xwm1992 merged 11 commits into from
Jul 14, 2023
Merged

[ISSUE #4208] Add JavaDoc for org.apache.eventmesh.runtime.admin APIs of dashboard #4210

xwm1992 merged 11 commits into from
Jul 14, 2023

Conversation

@Pil0tXia
Copy link
Member

@Pil0tXia Pil0tXia commented Jul 10, 2023

Fixes #4208.

Motivation

Please see #4208.

Modifications

Adds JavaDoc and single-line comments for all the classes and methods included in the eventmesh-dashboard APIs.

Another doc PR for other classes of org.apache.eventmesh.runtime.admin package which are not included in the eventmesh-dashboard APIs will be submitted later, in order to make reviewing less difficult.

Documentation

  • Does this pull request introduce a new feature? (no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
  • If a feature is not applicable for documentation, explain why?
  • If a feature is not documented yet in this PR, please create a followup issue for adding the documentation

@Pil0tXia Pil0tXia mentioned this pull request Jul 11, 2023
Merged
@codecov
Copy link

codecov bot commented Jul 11, 2023

Codecov Report

Merging #4210 (5448011) into master (3392b45) will decrease coverage by 0.03%.
The diff coverage is 0.00%.

❗ Current head 5448011 differs from pull request most recent head 95edf72. Consider uploading reports for the commit 95edf72 to get more accurate results

@@             Coverage Diff              @@
##             master    #4210      +/-   ##
============================================
- Coverage     16.93%   16.91%   -0.03%     
+ Complexity     1413     1412       -1     
============================================
  Files           589      589              
  Lines         25789    25786       -3     
  Branches       2397     2383      -14     
============================================
- Hits           4368     4361       -7     
- Misses        20985    20989       +4     
  Partials        436      436
Impacted Files Coverage Δ
...ntime/admin/controller/ClientManageController.java 97.87% <ø> (ø)
...h/runtime/admin/controller/HttpHandlerManager.java 100.00% <ø> (ø)
...esh/runtime/admin/handler/AbstractHttpHandler.java 66.66% <ø> (ø)
...sh/runtime/admin/handler/ConfigurationHandler.java 11.11% <ø> (ø)
.../eventmesh/runtime/admin/handler/EventHandler.java 6.18% <ø> (ø)
...tmesh/runtime/admin/handler/GrpcClientHandler.java 4.54% <ø> (ø)
...tmesh/runtime/admin/handler/HTTPClientHandler.java 4.87% <ø> (ø)
...ventmesh/runtime/admin/handler/MetricsHandler.java 5.88% <ø> (ø)
...entmesh/runtime/admin/handler/RegistryHandler.java 7.27% <ø> (ø)
...ntmesh/runtime/admin/handler/TCPClientHandler.java 4.59% <ø> (ø)
... and 2 more

... and 9 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

mxsm
mxsm approved these changes Jul 11, 2023
View reviewed changes
Copy link
Member

@mxsm mxsm left a comment

Choose a reason for hiding this comment

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

LGTM

@xwm1992 xwm1992 merged commit c82454b into apache:master Jul 14, 2023
@Pil0tXia Pil0tXia deleted the pil0txia_doc_4208 branch January 4, 2024 05:16
xuhongjia pushed a commit to Deckers-Ohana/eventmesh that referenced this pull request Mar 13, 2025
@Pil0tXia
[ISSUE apache#4208] Add JavaDoc for org.apache.eventmesh.runtime.admi…
c50f65f 
…n APIs of dashboard (apache#4210)

* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@xwm1992 xwm1992 xwm1992 approved these changes

@mxsm mxsm mxsm approved these changes

@lrhkobe lrhkobe lrhkobe approved these changes

@Alonexc Alonexc Alonexc approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Doc] Add JavaDoc for org.apache.eventmesh.runtime.admin APIs of dashboard

5 participants

@Pil0tXia @xwm1992 @mxsm @lrhkobe @Alonexc