Re: Javadoc HTML, JARs, and JXR

2023-02-14 Thread Ralph Goers
When Volkan and I discussed this the conclusion we mostly came to was that javadoc jars didn’t seem to be all that useful when source jars are available. When it comes to the web site the only Javadoc that is useful is for packages and classes you are going to write code against. This eliminates

Re: Javadoc HTML, JARs, and JXR

2023-02-14 Thread Matt Sicker
I suppose I should update that to use a package-info or similar, though as soon as you enter the docs, it has a bold link to “See IoBuilder”. That links to https://logging.apache.org/log4j/2.x/log4j-iostreams/apidocs/org/apache/logging/log4j/io/IoBuilder.html where the main docs are for this (tr

Re: Javadoc HTML, JARs, and JXR

2023-02-14 Thread Volkan Yazıcı
Matt, I am not inclined to publish Javadoc HTMLs for `log4j-iostreams` and `log4j-taglib` for the following reasons: - AFAIC, neither has any valuable information in their Javadoc. - Both need a decent developer-friendly short manual page, not a Javadoc HTML that needs to be deciphered by

Re: Javadoc HTML, JARs, and JXR

2023-02-14 Thread Tim Perry
Yes, that is true, but a different situation than I thought we were addressing. I meant my question to be "if both javadoc and source jars are available, would anyone somehow be able to get javadoc jars but not source jars?" On Tue, Feb 14, 2023 at 11:01 AM Volkan Yazıcı wrote: > Yes, shareware

Re: Javadoc HTML, JARs, and JXR

2023-02-14 Thread Volkan Yazıcı
Yes, shareware. That is, Javadoc JARs allow you to share your documentation without sharing your sources. AFAIK, almost all modern IDEs (Eclipse, NetBeans, IDEA) prioritize displaying documentation from source JARs, if available. Since ASF makes it obligatory to share sources, I see no purpose for

Re: Javadoc HTML, JARs, and JXR

2023-02-14 Thread Tim Perry
I was going to say the same thing. I'm wondering if there is ever a situation where someone can download the javadoc jars but not source jars. On Tue, Feb 14, 2023 at 9:58 AM Piotr P. Karwasz wrote: > Hi Matt, > > On Tue, 14 Feb 2023 at 17:58, Matt Sicker wrote: > > > > ... I’m not sure if IDEs

Re: Javadoc HTML, JARs, and JXR

2023-02-14 Thread Piotr P. Karwasz
Hi Matt, On Tue, 14 Feb 2023 at 17:58, Matt Sicker wrote: > > ... I’m not sure if IDEs and such can figure out the javadocs from the source > jar itself. I have disabled javadoc downloads in my Eclipse ages ago and it still shows me javadocs. Whenever sources are available, I don't believe that

Re: Javadoc HTML, JARs, and JXR

2023-02-14 Thread Matt Sicker
Can you also add the iostreams docs? Basically, the five listed on the top of https://logging.apache.org/log4j/2.x/javadoc.html should still be published, and when we get to 3.0, that will also need to include the plugins module. It would be nice if we could publish javadoc jars for everything,

Javadoc HTML, JARs, and JXR

2023-02-12 Thread Volkan Yazıcı
Hello, Javadocs were broken in `release-2.x`. That is, we were neither generating Javadoc JARs deployed to Nexus, nor generating Javadoc HTMLs that are linked in our website. I have just pushed a fix improvi