Skip to content

[core][doc] Fix malformed Doxygen comments - #65724

Open
zhjwpku wants to merge 1 commit into
ray-project:masterfrom
zhjwpku:docs/doxygen-comment-style
Open

zhjwpku wants to merge 1 commit into
ray-project:masterfrom
zhjwpku:docs/doxygen-comment-style

Conversation

@zhjwpku

@zhjwpku zhjwpku commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Description

Fix invalid Doxygen commands, misplaced parameter directions, stale parameter names, and return descriptions on void functions. Move paragraph commands that follow prose to dedicated lines and correct nearby documentation typos.

Related issues

This is simple enough not to create an issue.

@zhjwpku
zhjwpku requested review from a team, SongGuyang, kfstorm and raulchen as code owners August 25, 2026 11:44

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request performs a comprehensive cleanup of documentation and comments across various C++ source and header files, correcting typos, grammatical errors, and parameter formatting (such as updating Doxygen tags). The feedback highlights a minor grammatical error introduced in the comments of runtime_env_agent_client.cc where 'on which means' should be simplified to 'which means'.

Comment thread src/ray/raylet/runtime_env_agent_client.cc Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9b86c1b4d8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread cpp/include/ray/api.h
Comment thread cpp/include/ray/api.h
@zhjwpku
zhjwpku force-pushed the docs/doxygen-comment-style branch from 9b86c1b to b3614cb Compare August 25, 2026 11:52
@ray-gardener ray-gardener Bot added core Issues that should be addressed in Ray Core community-contribution Contributed by the community labels Aug 25, 2026
@Kunchd

Kunchd commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

@karticam PTAL

@github-actions

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had
any activity for 14 days. It will be closed in another 14 days if no further activity occurs.
Thank you for your contributions.

You can always ask for help on our discussion forum or Ray's public slack channel.

If you'd like to keep this open, just leave any comment, and the stale label will be removed.

@github-actions github-actions Bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Sep 15, 2026
@zhjwpku

zhjwpku commented Sep 15, 2026

Copy link
Copy Markdown
Contributor Author

@kfstorm @SongGuyang @raulchen Any chance that you take a look at this PR, many thanks.

@github-actions github-actions Bot added unstale A PR that has been marked unstale. It will not get marked stale again if this label is on it. and removed stale The issue is stale. It will be closed within 7 days unless there are further conversation labels Sep 15, 2026
Fix invalid Doxygen commands, misplaced parameter directions, stale
parameter names, and return descriptions on void functions. Move
paragraph commands that follow prose to dedicated lines and correct
nearby documentation typos.

Signed-off-by: Junwang Zhao <zhjwpku@gmail.com>
@zhjwpku
zhjwpku force-pushed the docs/doxygen-comment-style branch from b3614cb to bf38094 Compare October 10, 2026 09:43

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Contributed by the community core Issues that should be addressed in Ray Core unstale A PR that has been marked unstale. It will not get marked stale again if this label is on it.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants