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.

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

Switch license header to a multiline comment instead of JavaDoc #2412

Closed
shakuzen opened this issue Jan 20, 2021 · 1 comment · Fixed by #2940
Closed

Switch license header to a multiline comment instead of JavaDoc #2412

shakuzen opened this issue Jan 20, 2021 · 1 comment · Fixed by #2940
Labels
doc-update A documentation update type: task A general task
Milestone
1.7.8

Comments

@shakuzen
Copy link
Member

shakuzen commented Jan 20, 2021 •
edited

I noticed when browsing the JavaDocs site for Micrometer that package descriptions were populated with the license header. Also, license header in .java files is a JavaDoc syntax comment, which the IDE warns about. We should probably change them to all be non-JavaDoc multi-line comments instead. Then we can make meaningful package descriptions for reasons like micrometer-metrics/micrometer-docs#147 (comment) and avoid the IDE warning about JavaDoc comments above imports.
@shakuzen shakuzen added the type: task A general task label Jan 20, 2021
@shakuzen shakuzen added this to the 1.3.17 milestone Jan 20, 2021
@shakuzen shakuzen modified the milestones: 1.3.17, 1.3.18 Feb 16, 2021
@shakuzen shakuzen modified the milestones: 1.3.18, 1.3.x Mar 16, 2021
@shakuzen shakuzen modified the milestones: 1.3.x, 1.5.x Jun 22, 2021
@shakuzen shakuzen modified the milestones: 1.5.x, 1.6.x Aug 12, 2021
@jonatan-ivanov jonatan-ivanov modified the milestones: 1.6.x, 1.7.x Nov 10, 2021
izeye added a commit to izeye/micrometer that referenced this issue Jan 4, 2022
@izeye
Use non-Javadoc multi-line comments for license headers
bd7c591 
See micrometer-metricsgh-2412
@izeye izeye mentioned this issue Jan 4, 2022
Merged
@shakuzen shakuzen modified the milestones: 1.7.x, 1.7.8 Jan 4, 2022
@shakuzen shakuzen added the doc-update A documentation update label Jan 4, 2022
shakuzen pushed a commit that referenced this issue Jan 4, 2022
@izeye
Use non-Javadoc multi-line comments for license headers (#2940)
fc9c4ee 
See gh-2412
@shakuzen shakuzen linked a pull request Jan 4, 2022 that will close this issue
Use non-Javadoc multi-line comments for license headers #2940
Merged
@shakuzen
Copy link
Member Author

shakuzen commented Jan 4, 2022

Resolved by #2940

@shakuzen shakuzen closed this as completed Jan 4, 2022
izeye added a commit that referenced this issue Jan 4, 2022
@izeye
Use non-Javadoc multi-line comments for license headers for 1.8.x
add1583 
See gh-2412
@jonatan-ivanov jonatan-ivanov mentioned this issue Jan 5, 2022
Closed
jonatan-ivanov added a commit that referenced this issue Jan 5, 2022
@jonatan-ivanov
Automate non-Javadoc multi-line comments for license headers
418ebf8 
fixes gh-2942
related: gh-2412 gh-2940
jonatan-ivanov added a commit that referenced this issue Jan 5, 2022
@jonatan-ivanov
Regenerate license headers using the license plugin
988b5bd 
related: gh-2942 gh-2412 gh-2940
jonatan-ivanov added a commit that referenced this issue Jan 5, 2022
@jonatan-ivanov
Regenerate license headers using the license plugin for 1.8.x
8b4964e 
related: gh-2942 gh-2412 gh-2940
jonatan-ivanov added a commit that referenced this issue Jan 5, 2022
@jonatan-ivanov
Regenerate license headers using the license plugin for 1.8.x
3d08031 
related: gh-2942 gh-2412 gh-2940
@shakuzen shakuzen changed the title License header is a JavaDoc comment but probably shouldn't be Switch license header to a multiline comment instead of JavaDoc Jan 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc-update A documentation update type: task A general task
Projects
None yet
Milestone
1.7.8
Development

Successfully merging a pull request may close this issue.

Use non-Javadoc multi-line comments for license headers izeye/micrometer
2 participants
@jonatan-ivanov @shakuzen