RFC: Fix some javadoc issues #3509
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rPraml
commented
Oct 25, 2024
| * Controls if Ebean should ignore <code>&x64;javax.validation.contstraints.NotNull</code> or | ||
| * <code>&x64;jakarta.validation.contstraints.NotNull</code> | ||
| * Controls if Ebean should ignore <code>@javax.validation.contstraints.NotNull</code> or | ||
| * <code>@jakarta.validation.contstraints.NotNull</code> | ||
| * with respect to generating a <code>NOT NULL</code> column. |
There was a problem hiding this comment.
this is obviously wrong
| @@ -239,7 +239,7 @@ | |||
| <groupId>org.apache.maven.plugins</groupId> | |||
| <artifactId>maven-javadoc-plugin</artifactId> | |||
| <configuration> | |||
| <doctitle>Ebean 12</doctitle> | |||
| <doctitle>Ebean 14</doctitle> | |||
| <overview>src/main/java/io/ebean/overview.html</overview> | |||
There was a problem hiding this comment.
This configuration is not used, when javadoc is called for other modules (javadoc' has not been previously called for the module: 'io.ebean:ebean-api:jar)
| @@ -56,6 +56,7 @@ | |||
| <ebean-agent.version>14.8.0</ebean-agent.version> | |||
| <ebean-maven-plugin.version>14.8.0</ebean-maven-plugin.version> | |||
| <surefire.useModulePath>false</surefire.useModulePath> | |||
| <maven-javadoc-plugin.version>3.10.1</maven-javadoc-plugin.version> | |||
There was a problem hiding this comment.
java11-oss defines 3.7.0 (but both versions have the same problem)
| <artifactId>maven-javadoc-plugin</artifactId> | ||
| <version>${maven-javadoc-plugin.version}</version> | ||
| <configuration> | ||
| <additionalOptions>-Xdoclint:none</additionalOptions> |
There was a problem hiding this comment.
The problem is, that there are many javadocs, that uses non-HTML4-compliant tags.
I don't know, what's the best here. Change the HTML5 tags (that obviously work in the browser) to HTML4 tags or disable linting in ebean-paren (or only in specific module)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When running a maven build, I get
Then I get
In the invoker log, there I find