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

Fix javadoc errors and warnings for Kitodo-API #6162

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

stweil
Copy link
Member

@stweil stweil commented Jul 31, 2024

This partially fixes issue #6161.

@stweil
Copy link
Member Author

stweil commented Jul 31, 2024

After these fixes, the next errors and warnings are reported for Kitodo-DataManagement.

Copy link
Member Author

@stweil stweil left a comment

Choose a reason for hiding this comment

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

HH:MM:SS.mmm is a better description for the expected time format than showing the regular expression.

@stweil
Copy link
Member Author

stweil commented Aug 30, 2024

Can this PR be merged? Then I could work on the Javadoc warnings and errors for other modules of Kitodo.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
Suggested-by: Henning Gerhardt <henning.gerhardt@slub-dresden.de>
Signed-off-by: Stefan Weil <sw@weilnetz.de>
Signed-off-by: Stefan Weil <sw@weilnetz.de>
@stweil
Copy link
Member Author

stweil commented Sep 2, 2024

Many of the other javadoc errors are similar to this one:

[ERROR] /Users/stweil/src/github/kitodo/kitodo-production/Kitodo-DataManagement/src/main/java/org/kitodo/data/elasticsearch/api/TypeInterface.java:21: error: bad use of '>'
[ERROR]  * Note: MySQL -> Databases -> Tables -> Columns/Rows ElasticSearch -> Indices

Do you have a suggestion how this should be fixed? Would using "→" be okay?

@stweil
Copy link
Member Author

stweil commented Sep 27, 2024

How can we proceed with this topic?

@stweil
Copy link
Member Author

stweil commented Oct 31, 2024

@solth, is there still anything that prevents this PR from being merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants