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.

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

[MJAVADOC-657] The fix operation duplicates annotations on private methods that have an annotation line between the method body and the javadoc comments. #52

Merged
merged 1 commit into from Aug 21, 2020
Merged

[MJAVADOC-657] The fix operation duplicates annotations on private methods that have an annotation line between the method body and the javadoc comments. #52

merged 1 commit into from Aug 21, 2020

Conversation

XenoAmess
Copy link
Contributor

@XenoAmess XenoAmess commented Aug 20, 2020 •
edited

Hi.

There be several bugs happened during my usage of maven-javadoc-plugin.

Now I found some time to report them.

I add it in unit test(and it will fail the test now) in this pr, showing when it happens, how it will harm the codes, and what be the expected result.

Now I'm being looking up the sources to see if I can fix it by myself, but I think it be good to let you know about the bug before I started.

@XenoAmess
Copy link
Contributor Author

XenoAmess commented Aug 20, 2020 •
edited

BTW this bug was found when I build my lib https://github.com/cyanpotion/x8l
So yes, this bug does not only exist, but there really be users (at least one user means me) affected by it.

@XenoAmess
Copy link
Contributor Author

XenoAmess commented Aug 20, 2020 •
edited

@elharo Hi. I'm trying to fix it.
If I failed I will let you know, but I want to try it first.

@XenoAmess XenoAmess force-pushed the fix_bug_about_annotation_in_operation_fix branch 3 times, most recently from 5a473fb to 78873e4 Compare August 20, 2020 12:33
@XenoAmess
Copy link
Contributor Author

XenoAmess commented Aug 20, 2020 •
edited

@elharo
Hi. I fixed the bug.
please review this pr.
thanks.

@XenoAmess
Copy link
Contributor Author

I really hope we can solve this fast.
Because I have another bug to fix for this repo. (that is also about "fix" operation)
But I don't want to open two prs for this repo in same time (and on the same function)

@elharo
Copy link
Contributor

elharo commented Aug 20, 2020

Please file a JIRA issue for the second bug.

@XenoAmess
Copy link
Contributor Author

XenoAmess commented Aug 20, 2020 •
edited

@elharo

Please file a JIRA issue for the second bug.

I fired that bug at MJAVADOC-658.
Yet another bug at MJAVADOC-659.

@XenoAmess XenoAmess requested a review from elharo August 21, 2020 10:49
elharo
elharo reviewed Aug 21, 2020
View reviewed changes
Copy link
Contributor

@elharo elharo left a comment

Choose a reason for hiding this comment

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

Since we use bug for automated release notes, could you update the title of the bug to explain what the bug is?

@XenoAmess
Copy link
Contributor Author

XenoAmess commented Aug 21, 2020 •
edited

Since we use bug for automated release notes, could you update the title of the bug to explain what the bug is?

@elharo I didn't quite get what you mean.
do you mean I should change the text of this pr's title ("[MJAVADOC-657] found a bug about wrongly handling annotations when using fix operation ") to some more detailed description of this bug?

@XenoAmess XenoAmess changed the title [MJAVADOC-657] found a bug about wrongly handling annotations when using fix operation [MJAVADOC-657] wrongly handling annotations when using fix operation: will duplicate annotations in some situations when access of the method be private Aug 21, 2020
@XenoAmess XenoAmess changed the title [MJAVADOC-657] wrongly handling annotations when using fix operation: will duplicate annotations in some situations when access of the method be private [MJAVADOC-657] wrongly handling annotations when using fix operation: will duplicate annotations in some situations when access of a function be private, and it have an annotation line between function body and javadoc comments. Aug 21, 2020
@XenoAmess XenoAmess requested a review from elharo August 21, 2020 12:15
@XenoAmess XenoAmess changed the title [MJAVADOC-657] wrongly handling annotations when using fix operation: will duplicate annotations in some situations when access of a function be private, and it have an annotation line between function body and javadoc comments. [MJAVADOC-657] The fix operation duplicates annotations on private methods that have an annotation line between the method body and the javadoc comments. Aug 21, 2020
@XenoAmess XenoAmess requested a review from elharo August 21, 2020 12:58
@XenoAmess
Copy link
Contributor Author

@elharo
Hi.
If there be any more changes requests to this pr?
Or should I sqruash commits now?

@XenoAmess XenoAmess requested a review from elharo August 21, 2020 14:09
elharo
elharo reviewed Aug 21, 2020
View reviewed changes
Copy link
Contributor

@elharo elharo left a comment

Choose a reason for hiding this comment

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

I need to familiarize myself with this code. No immediate comments. You can squash if you like.

@XenoAmess
Copy link
Contributor Author

@elharo

I need to familiarize myself with this code. No immediate comments. You can squash if you like.

OK, got it.
I always do sqruash only when we finished all changes, so I will just wait for you to make sure this pr acceptable, or get more refine-requests.

@XenoAmess XenoAmess force-pushed the fix_bug_about_annotation_in_operation_fix branch from 05d741b to ab17864 Compare August 21, 2020 14:31
@XenoAmess
Copy link
Contributor Author

XenoAmess commented Aug 21, 2020 •
edited

@elharo OK, sqruashed.

@XenoAmess XenoAmess requested a review from elharo August 21, 2020 14:32
@elharo
Copy link
Contributor

elharo commented Aug 21, 2020

running through jenkins: https://ci-builds.apache.org/job/Maven/job/maven-box/job/maven-javadoc-plugin/job/52/

@XenoAmess
[MJAVADOC-657] The fix operation duplicates annotations on private me…
de76473 
…thods that have an annotation line between the method body and the javadoc comments.
@XenoAmess XenoAmess force-pushed the fix_bug_about_annotation_in_operation_fix branch from ab17864 to de76473 Compare August 21, 2020 17:05
@XenoAmess
Copy link
Contributor Author

XenoAmess commented Aug 21, 2020 •
edited

@elharo
Hi.
I see the result.
It fails because some check-style issue, about two lines of the codes are larger than 120.
Now it get fixed.
So please re-review&re-jenkins.
Thanks.

@elharo
Copy link
Contributor

elharo commented Aug 21, 2020

running jenkins again on https://ci-builds.apache.org/job/Maven/job/maven-box/job/maven-javadoc-plugin/job/657/

@elharo
Copy link
Contributor

elharo commented Aug 21, 2020

Jenkins passed.

@elharo elharo merged commit ba2c180 into apache:master Aug 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elharo elharo Awaiting requested review from elharo

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@XenoAmess @elharo