Re: Javadoc beyond 17

2022-11-11 Thread Mark Thomas

On 11/11/2022 07:37, Rémy Maucherat wrote:

On Thu, Nov 10, 2022 at 4:37 PM Mark Thomas  wrote:


Rémy,

Which Java vendor and version was this with? I've just tested with
Temurin 19.0.1+10 and the latest OpenJDK 20 EA release and both generate
the Javadoc for 11.0.x without errors (lots of warnings as expected).


I tried with Java 18 from
https://adoptium.net/temurin/releases/?version=18 and it's the bunch
of new warnings (but no errors) with "ant javadoc".
I noticed this first with the Jakarta tool, since the github actions
treat the javadoc warnings as problems. Previously all the javadoc
warnings were fixed in Tomcat, but I'm not sure this is worth doing
again.


Got it.


I found the details for the most annoying new feature (having to have
empty constructors just to document them ...) here:
https://stackoverflow.com/questions/72393731/how-can-i-disable-a-specific-type-of-missing-comment-warning-in-javadoc


I agree it is annoying. I really don't see the benefit of Javadoc that 
just says "Create a new instance."


I think I'll carry on doing what I have been doing for a while. Working 
through the current Javadoc warnings and fixing them when I have a spare 
5-10 mins.


If it starts breaking the build then that is when I'd want to start 
looking at alternative solutions.


Mark



Rémy



Mark


On 02/11/2022 20:08, Mark Thomas wrote:

On 02/11/2022 15:52, Rémy Maucherat wrote:

Hi,

It seems javadoc has become a lot stricter moving forward (starting
with Java 18 it seems), where basically everything now needs a
javadoc. So will we be keeping a zero warning policy, or are we going
to decide to relax it ?
If not, this will keep up busy for some time ;)

I noticed the problem while looking at the github actions failures
with Java 18+ and seeing the javadoc output after fixing.


It depends what the minimum Java version for Jakarta EE 11 is ;)

More seriously, I have been slowly working through these over time with
the plan / hope to have fixed them by the time we absolutely have to. It
does seem to be a bit of a moving target depending on JVM vendor and
Java version.

We should parameterise failonerror and failonwarning so users can
compile more easily on later versions. And we can change default if we
reach a point we need to.

Mark

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



Re: Javadoc beyond 17

2022-11-10 Thread Rémy Maucherat
On Thu, Nov 10, 2022 at 4:37 PM Mark Thomas  wrote:
>
> Rémy,
>
> Which Java vendor and version was this with? I've just tested with
> Temurin 19.0.1+10 and the latest OpenJDK 20 EA release and both generate
> the Javadoc for 11.0.x without errors (lots of warnings as expected).

I tried with Java 18 from
https://adoptium.net/temurin/releases/?version=18 and it's the bunch
of new warnings (but no errors) with "ant javadoc".
I noticed this first with the Jakarta tool, since the github actions
treat the javadoc warnings as problems. Previously all the javadoc
warnings were fixed in Tomcat, but I'm not sure this is worth doing
again.

I found the details for the most annoying new feature (having to have
empty constructors just to document them ...) here:
https://stackoverflow.com/questions/72393731/how-can-i-disable-a-specific-type-of-missing-comment-warning-in-javadoc

Rémy

>
> Mark
>
>
> On 02/11/2022 20:08, Mark Thomas wrote:
> > On 02/11/2022 15:52, Rémy Maucherat wrote:
> >> Hi,
> >>
> >> It seems javadoc has become a lot stricter moving forward (starting
> >> with Java 18 it seems), where basically everything now needs a
> >> javadoc. So will we be keeping a zero warning policy, or are we going
> >> to decide to relax it ?
> >> If not, this will keep up busy for some time ;)
> >>
> >> I noticed the problem while looking at the github actions failures
> >> with Java 18+ and seeing the javadoc output after fixing.
> >
> > It depends what the minimum Java version for Jakarta EE 11 is ;)
> >
> > More seriously, I have been slowly working through these over time with
> > the plan / hope to have fixed them by the time we absolutely have to. It
> > does seem to be a bit of a moving target depending on JVM vendor and
> > Java version.
> >
> > We should parameterise failonerror and failonwarning so users can
> > compile more easily on later versions. And we can change default if we
> > reach a point we need to.
> >
> > Mark
> >
> > -
> > To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
> > For additional commands, e-mail: dev-h...@tomcat.apache.org
> >
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
> For additional commands, e-mail: dev-h...@tomcat.apache.org
>

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



Re: Javadoc beyond 17

2022-11-10 Thread Mark Thomas

Rémy,

Which Java vendor and version was this with? I've just tested with 
Temurin 19.0.1+10 and the latest OpenJDK 20 EA release and both generate 
the Javadoc for 11.0.x without errors (lots of warnings as expected).


Mark


On 02/11/2022 20:08, Mark Thomas wrote:

On 02/11/2022 15:52, Rémy Maucherat wrote:

Hi,

It seems javadoc has become a lot stricter moving forward (starting
with Java 18 it seems), where basically everything now needs a
javadoc. So will we be keeping a zero warning policy, or are we going
to decide to relax it ?
If not, this will keep up busy for some time ;)

I noticed the problem while looking at the github actions failures
with Java 18+ and seeing the javadoc output after fixing.


It depends what the minimum Java version for Jakarta EE 11 is ;)

More seriously, I have been slowly working through these over time with 
the plan / hope to have fixed them by the time we absolutely have to. It 
does seem to be a bit of a moving target depending on JVM vendor and 
Java version.


We should parameterise failonerror and failonwarning so users can 
compile more easily on later versions. And we can change default if we 
reach a point we need to.


Mark

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



Re: Javadoc beyond 17

2022-11-02 Thread Mark Thomas

On 02/11/2022 15:52, Rémy Maucherat wrote:

Hi,

It seems javadoc has become a lot stricter moving forward (starting
with Java 18 it seems), where basically everything now needs a
javadoc. So will we be keeping a zero warning policy, or are we going
to decide to relax it ?
If not, this will keep up busy for some time ;)

I noticed the problem while looking at the github actions failures
with Java 18+ and seeing the javadoc output after fixing.


It depends what the minimum Java version for Jakarta EE 11 is ;)

More seriously, I have been slowly working through these over time with 
the plan / hope to have fixed them by the time we absolutely have to. It 
does seem to be a bit of a moving target depending on JVM vendor and 
Java version.


We should parameterise failonerror and failonwarning so users can 
compile more easily on later versions. And we can change default if we 
reach a point we need to.


Mark

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



Javadoc beyond 17

2022-11-02 Thread Rémy Maucherat
Hi,

It seems javadoc has become a lot stricter moving forward (starting
with Java 18 it seems), where basically everything now needs a
javadoc. So will we be keeping a zero warning policy, or are we going
to decide to relax it ?
If not, this will keep up busy for some time ;)

I noticed the problem while looking at the github actions failures
with Java 18+ and seeing the javadoc output after fixing.

Rémy

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org