Skip to content

[ISSUE #4182] Add JavaDoc and Comments for eventmesh-admin-rocketmq Module #4183

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

[ISSUE #4182] Add JavaDoc and Comments for eventmesh-admin-rocketmq Module #4183

xwm1992 merged 8 commits into from
Jul 14, 2023

Conversation

@Pil0tXia
Copy link
Member

@Pil0tXia Pil0tXia commented Jul 5, 2023

Fixes #4182.

Motivation

Please see #4182.

Modifications

I have written these comments following the examples set by various common Java libraries. I have paid attention to formatting and ensured the correct usage of tags such as <p>, <pre>, @see, @link, @linkplain, @code and others.

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

mxsm
mxsm approved these changes Jul 6, 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

@codecov
Copy link

codecov bot commented Jul 6, 2023 •
edited
Loading

Codecov Report

Merging #4183 (386bc8c) into master (bae1307) will not change coverage.
The diff coverage is 0.00%.

❗ Current head 386bc8c differs from pull request most recent head e32f812. Consider uploading reports for the commit e32f812 to get more accurate results

@@            Coverage Diff            @@
##             master    #4183   +/-   ##
=========================================
  Coverage     16.92%   16.92%           
  Complexity     1412     1412           
=========================================
  Files           589      589           
  Lines         25789    25789           
  Branches       2397     2397           
=========================================
  Hits           4366     4366           
  Misses        20986    20986           
  Partials        437      437
Impacted Files Coverage Δ
...esh/admin/rocketmq/controller/AdminController.java 0.00% <ø> (ø)
...ventmesh/admin/rocketmq/handler/TopicsHandler.java 0.00% <0.00%> (ø)
...esh/admin/rocketmq/request/TopicCreateRequest.java 100.00% <ø> (ø)
...entmesh/admin/rocketmq/response/TopicResponse.java 46.15% <ø> (ø)
.../eventmesh/admin/rocketmq/util/RequestMapping.java 70.00% <ø> (ø)
...entmesh/admin/rocketmq/util/UrlMappingPattern.java 92.85% <ø> (ø)
...ntime/admin/controller/ClientManageController.java 97.87% <ø> (ø)

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

xwm1992
xwm1992 previously approved these changes Jul 6, 2023
View reviewed changes
@Pil0tXia
Copy link
Member Author

Pil0tXia commented Jul 9, 2023

@lrhkobe PTAL~ 😉

lrhkobe
lrhkobe previously approved these changes Jul 10, 2023
View reviewed changes
@Pil0tXia Pil0tXia dismissed stale reviews from lrhkobe and xwm1992 via e32f812 July 10, 2023 15:38
@Pil0tXia Pil0tXia requested review from lrhkobe and xwm1992 July 11, 2023 02:13
@Pil0tXia
Copy link
Member Author

Pil0tXia commented Jul 11, 2023 •
edited
Loading

I'm sry. I submitted a commit to solve the conflict for #4210, intending to save you both the time of leaving a comment saying "Please resolve the conflict." However, it turns out that this operation requires you two @xwm1992 @lrhkobe review again. 🤐

@xwm1992 xwm1992 merged commit d8b99af into apache:master Jul 14, 2023
@Pil0tXia Pil0tXia deleted the pil0txia_doc_4182 branch January 4, 2024 05:06
xuhongjia pushed a commit to Deckers-Ohana/eventmesh that referenced this pull request Mar 13, 2025
@Pil0tXia
[ISSUE apache#4182] Add JavaDoc and Comments for eventmesh-admin-rock…
8a3ea1f 
…etmq Module (apache#4183)

* doc: Write JavaDoc and comments for AdminController

* doc: Write JavaDoc and comments for TopicsHandler

* doc: Write JavaDoc and comments for TopicCreateRequest

* doc: Write JavaDoc and comments for TopicResponse

* doc: Write JavaDoc and comments for RequestMapping

* doc: Write JavaDoc and comments for UrlMappingPattern

* doc: Update JavaDoc of ClientManageController#start

* chore: remove 1 old doc to solve the conflict
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pandaapo pandaapo pandaapo left review comments

@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 eventmesh-admin-rocketmq Module

6 participants

@Pil0tXia @xwm1992 @mxsm @lrhkobe @pandaapo @Alonexc