Re: Markdown JavaDoc

2024-12-09 Thread Aleksey Yeshchenko
It won’t work *properly* with current versions but the tooling should still handle it gracefully without blowing up. It just won’t generate the full docs. But arguably we don’t really care about that much - as other have mentioned, C* javadoc comments are mainly consumed from inside IDEs. So mi

Re: Markdown JavaDoc

2024-12-04 Thread Francisco Guerrero
Is there a dependency on Java 23 to make the `ant javadoc` tooling to work? My understanding is that this change is coming in the newer Java versions. On 2024/12/02 15:30:14 Branimir Lambov wrote: > Hello, > > What is the community's stand on using the new Markdown variation of > JavaDoc? > https

Re: Markdown JavaDoc

2024-12-04 Thread Mick Semb Wever
+1 for more code (github/ide) readable in-code documentation. Do we use javadoc anywhere anymore, or read its generated apidocs anywhere ? We removed that target from the build cycle, and don't publish those artefacts or deploy the apidocs anywhere anymore… I would say folk are either got the c

Markdown JavaDoc

2024-12-02 Thread Branimir Lambov
Hello, What is the community's stand on using the new Markdown variation of JavaDoc? https://docs.oracle.com/en/java/javase/23/javadoc/using-markdown-documentation-comments.html I find it as a dramatic improvement over the old style, which is very unpleasant to write and close to unreadable anywh

Re: Markdown JavaDoc

2024-12-02 Thread Benedict
I would support this. I don’t actually mind reading unformatted javadoc that’s been written with a light touch, but I agree our normal usage is much more aligned with Markdown. I only lament that they choose triple slash as the prefix, but I have no doubt my tastes will adapt. > On 2 Dec 2024,