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

Fixes some JavaDoc errors #9911

Merged
merged 1 commit into from
May 17, 2023
Merged

Fixes some JavaDoc errors #9911

merged 1 commit into from
May 17, 2023

Conversation

koppor
Copy link
Member

@koppor koppor commented May 17, 2023

This PR fixes half of the javadoc errors.

Refs koppor#475

Maybe, the other errors are fixed by some contributors or by us later.

Compulsory checks

@koppor koppor added the type: code-quality Issues related to code or architecture decisions label May 17, 2023
@@ -6,7 +6,7 @@

/**
* Searches web resources for bibliographic information based on a {@link BibEntry}.
* Useful to <emph>complete</emph> an existing entry with fetched information.
* Useful to <b>complete</b> an existing entry with fetched information.
Copy link
Member

@calixtus calixtus May 17, 2023

Choose a reason for hiding this comment

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

Could be discussed, as emphasized is not the same as bold, rather italic, but if this is mentioned as an error and this is about a javadoc comment, the discussion really does not matter ;-).

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, the gradle task did say emph is an error. i did not came into my bind, therefore I put b to have something.

The correct fix would have been to use em 🙈

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em

@Siedlerchr Siedlerchr merged commit 822db21 into main May 17, 2023
@Siedlerchr Siedlerchr deleted the fix-javadoc branch May 17, 2023 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: code-quality Issues related to code or architecture decisions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants