Add comprehensive JavaDoc documentation to DOM utility classes#2909
Open
RagiGeorge wants to merge 1 commit intoeclipse-jdt:masterfrom
Open
Add comprehensive JavaDoc documentation to DOM utility classes#2909RagiGeorge wants to merge 1 commit intoeclipse-jdt:masterfrom
RagiGeorge wants to merge 1 commit intoeclipse-jdt:masterfrom
Conversation
RagiGeorge
force-pushed
the
updated-java-doc
branch
from
faed42e to
0846722
Compare
RagiGeorge
force-pushed
the
updated-java-doc
branch
from
7b5adaa to
a2203d2
Compare
Contributor
Author
|
@noopur2507 |
SougandhS
force-pushed
the
updated-java-doc
branch
from
a2203d2 to
20a55e1
Compare
noopur2507
requested changes
Apr 10, 2026
Member
noopur2507
left a comment
noopur2507
left a comment
There was a problem hiding this comment.
Thanks for adding Javadocs. A few things to address first:
- Some comments feel generic. Javadocs should describe the intended behaviour rather than explain the code.
- A few additions like since tags seem incorrect for existing internal code.
- Some methods (like simple getters) are over-documented, which we generally avoid.
- Please see existing Javadocs in similar classes and align wording and level of detail accordingly.
RagiGeorge
force-pushed
the
updated-java-doc
branch
3 times, most recently
from
7b0ddce to
d5f943b
Compare
RagiGeorge
force-pushed
the
updated-java-doc
branch
from
d5f943b to
94c3af7
Compare
Contributor
Author
|
hi @noopur2507 incorporated review comment, Requesting you to kindly review when you get a chance. Thanks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What it does
This PR enhances the documentation for three core utility classes in the org.eclipse.jdt.internal.corext.dom package by adding comprehensive JavaDoc comments.