Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix and reformat javadoc author tag #1486

Merged
merged 2 commits into from
Jan 9, 2023
Merged

Conversation

axmmisaka
Copy link
Collaborator

@axmmisaka axmmisaka commented Nov 22, 2022

See #1477 for more context, the questions are:

  1. Do we want to keep e-mail or only keep name, effectively eliminating the problem?
  2. Do we use {@literal } or < >?
  3. Why are emails not showing in the generated Javadoc
  4. Why is javadoc build failing

Copy link
Collaborator

@cmnrd cmnrd left a comment

Choose a reason for hiding this comment

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

I think using {@literal } is a great solution. How does this look in the generated rendered html?

@lhstrh
Copy link
Member

lhstrh commented Nov 23, 2022

The description of the PR seems to suggest that JavaDoc generation is broken?

@axmmisaka
Copy link
Collaborator Author

Yeah, doesn't appear to be working as I can't find @author tags in generated HTML plus ./gradlew javadoc is spitting out tons of errors on java files in src-gen

@axmmisaka axmmisaka force-pushed the axmmisaka/fix-javadoc-author-email branch from 3f5c80f to 83c2c5c Compare December 24, 2022 00:44
@axmmisaka axmmisaka marked this pull request as ready for review December 24, 2022 00:56
@axmmisaka
Copy link
Collaborator Author

axmmisaka commented Dec 24, 2022

./gradlew javadoc doesn't produce javadoc with author tag (and generate docs for files under src-gen which doesn't appear to be right) so I can't test this locally, and my intellij generate javadoc is not working, F

Now every and all author tag will be like

/**
* @author Hitori "Bocchi" Gotō
*/

Copy link
Collaborator

@cmnrd cmnrd left a comment

Choose a reason for hiding this comment

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

This looks great! Thanks!

@cmnrd
Copy link
Collaborator

cmnrd commented Jan 5, 2023

I think we should merge this. However, this also means we need to manually integrate the changes into #1482... @a-sr What do you think?

@a-sr
Copy link
Collaborator

a-sr commented Jan 9, 2023

I agree. You can merge this. There are already some other conflicts in #1482 that need to be resolved manually. A few more will not change much.

@cmnrd cmnrd merged commit 31f68ad into master Jan 9, 2023
@cmnrd cmnrd deleted the axmmisaka/fix-javadoc-author-email branch January 9, 2023 12:08
@cmnrd cmnrd changed the title [Chore] [WIP] Fix and reformat javadoc @author tag Fix and reformat javadoc @author tag Jan 9, 2023
@lhstrh lhstrh changed the title Fix and reformat javadoc @author tag Fix and reformat javadoc author tag Mar 1, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants