On APIdia there are now quick-selectors for Jakarta EE 11 API docs to reduce the view to core or web profile. You can also select e.g. platform without core and web to see precisely those modules that are *only* available in the full platform profile.
#java #javadoc #jakartaee

JakartaEE 11 docs on APIdia:
https://apidia.net/mvn/jakarta.platform/jakartaee/11
Note: If you visited the site recently, it may be necessary to reload with ctrl-F5 to get this new feature working. (That forces your browser to reload cached resources such as Javascript files.)

You don't need a lot of tooling for a quick sanity check if you expose only what you want to expose from a #Java package. Generate your #Javadoc and see what it sees and publishes. Its default inclusions are just spot on.

Jakarta 11 has been released! Congrats @jakartaee and OmniFish for getting this shipped!

API documentation is readily available on APIdia:
https://apidia.net/mvn/jakarta.platform/jakartaee/11

Compared to the official Javadocs, the docs on APIdia include the module pages, yet integrated into one coherent doc profile. E.g. check the new spec jakarta-data: https://apidia.net/mvn/jakarta.platform/jakartaee/11.0.0/?pck=jakarta.data-all-classes&cls=jakarta.data-module

#java #javadoc #jakartaee #jdk

libGDX is a Java game development framework with exceptional cross-platform support: It supports building for Desktop, Android, iOS and Browsers/HTML5 from a single consistent Java codebase.
API docs of its latest release can be browsed on APIdia:
libGDX:
https://apidia.net/mvn/com.badlogicgames.gdx/gdx-platform
Controller Extension:
https://apidia.net/mvn/com.badlogicgames.gdx-controllers/gdx-controllers
#java #javadoc #jdk #libgdx

Flexmark is a CommonMark/Markdown parser for Java, offering granular control of the parsing process, HTML rendering, emulation of other parsers, conversion modules e.g. to PDF or DOCX and a vast set of extension modules. The full flexmark module family is available on APIdia for browsing API docs in a single integrated doc profile: https://apidia.net/mvn/com.vladsch.flexmark/flexmark-all

#java #javadoc #markdown #jdk #flexmark

We made it to JFX-Central links of the week once again!
https://foojay.social/@frankdelporte/114635312724814686

Thank you, JFX-Central and all authors of the linked projects and articles, for keeping Java FX vivid and enabling Java on the frontend!
#javafx #LinksOfTheWeek #java #jdk #javadoc

We recently added API docs for the JavaFX components by DLSC, e.g. for PDF viewing, form-based UIs, preferences, picker controls and more. These controls are frequent and crucial building blocks of advanced JavaFX applications.
#javafx #java #jdk #javadoc

afterburner: https://apidia.net/mvn/com.dlsc.afterburner/afterburner.fx
forms: https://apidia.net/mvn/com.dlsc.formsfx/formsfx-core
gems: https://apidia.net/mvn/com.dlsc.gemsfx/gemsfx
keyboard: https://apidia.net/mvn/com.dlsc.keyboardfx/keyboardfx
pdfview: https://apidia.net/mvn/com.dlsc.pdfviewfx/pdfviewfx
picker: https://apidia.net/mvn/com.dlsc.pickerfx/pickerfx
phonenumber: https://apidia.net/mvn/com.dlsc.phonenumberfx/phonenumberfx
preferences: https://apidia.net/mvn/com.dlsc.preferencesfx/preferencesfx-core
retrofit: https://apidia.net/mvn/com.dlsc.retrofitfx/retrofitfx
showcase: https://apidia.net/mvn/com.dlsc.showcasefx/showcasefx
unit: https://apidia.net/mvn/com.dlsc.unitfx/unitfx
workbench: https://apidia.net/mvn/com.dlsc.workbenchfx/workbenchfx-core
GMaps: https://apidia.net/mvn/com.dlsc/GMapsFX

Just wasted >7 hours wondering why #Maven failed to generate my JavaDoc with #PlantUML class diagrams.

The reason? For unknown reason, #UMLDoclet (a plugin for JavaDoc used to generate the diagrams) throws an IllegalArgumentException if you set #JavaDoc's output level to “verbose”. 🤡 😭

This issue is known and had supposedly been fixed in 2024 but the fix does not appear to actually work: https://github.com/talsma-ict/umldoclet/issues/633

Question for #OpenSource #license experts: when you ship a #JavaDoc jar, it contains some JS files that are GPL licensed. Does that impact the all over licensing of your product?

I will never understand teams that don't believe in writing #javadoc. You may think your code is SeLf dOcUmeNtIng, but it's not. It never is. It's always a lie you tell yourself.

For the love of all that is good, at the very least explain *what a class is for* and how it fits into the bigger picture.

Even if you think it's obvious. Nay, especially then!! I assure you, it won't be obvious to you in 5 years time, nor to the new guy inheriting your spaghetti in 10 years time.

#java

Method Categories with Emojis in IntelliJ Javadoc | @thedonraab https://donraab.medium.com/associating-method-categories-with-emojis-in-intellij-and-javadoc-a82aebe1e903
#Java #IntelliJ #javadoc

If you are doing #Java #programming, and you've downloaded a jar of #Javadoc documentation for some library, #Firefox can directly display it without unpacking the jar!

Just prepend `jar:file://`, and append `!/index.html`, to form a URL.

For example, if the jar is located at:
/home/you/.m2/repository/com/example/example-library/1.0/example-library-1.0-javadoc.jar

Then use this URL:
jar:file:///home/you/.m2/repository/com/example/example-library/1.0/example-library-1.0-javadoc.jar!/index.html

I finished another round of modernizing my (Non)deterministic Finite Automata (#nfa, #dfa) #Java library.

Now with #Javadoc on the #Codeberg pages for the project. The link is at the top of the README.

https://codeberg.org/harald/monqjfa

#SoftwareDocumentation #JavaDoc #Markdown #APIDocumentation #TechnicalWriting: "Summary:
Enable JavaDoc documentation comments to be written in Markdown rather than solely in a mixture of HTML and JavaDoc @-tags.

Goals:
- Make API documentation comments easier to write and easier to read in source form by introducing the ability to use Markdown syntax in documentation comments, alongside HTML elements and JavaDoc tags.

- Do not adversely affect the interpretation of existing documentation comments.

- Extend the Compiler Tree API to enable other tools that analyze documentation comments to handle Markdown content in those comments.

Non-Goals:
- It is not a goal to enable automated conversion of existing documentation comments to Markdown syntax."

https://openjdk.org/jeps/467

any #Java power user around that has some clever idea for this?

Code examples help people see how #APIs are used, but JavaDoc does not have that unless you explicit write something up in the docs.

But then, many tools have plenty of test cases. I always pointed people to the (unit) tests for examples.

How can I do something to point to these tests or even add the test as code example in the #JavaDoc?

Proposal to support Markdown in #Javadoc comments.

One goal: "Make API documentation comments easier to write and to read in source form by introducing the ability to use Markdown syntax in documentation comments, alongside HTML elements and JavaDoc tags, without adversely affecting the interpretation of any existing documentation comments."

https://mail.openjdk.org/pipermail/javadoc-dev/2023-October/006455.html

#openjdk #java

@java_discussions markdown is a mess. I'm all for exponding the #javadoc system, but it's sad that #markdown would be explicitly supported without making #asciidoc and other documentation-oriented formats usable. The javadoc section should start with "markdown" or "md" at least. Name it.

Javadoc comments can grow and change with the code...and be used to generate automated documentation for the API(s) calling code will use to invoke your code. #java #documentation #javadoc

http://codingchica.com/2023/07/07/javadoc-comments-moving-the-documentation-in-with-the-code/

Having the documentation done as part of the code updates make sure everything is kept in sync and updated. Let's generate Javadoc documentation as part of the build. #java #maven #build #stepbystep #javadoc

http://codingchica.com/2023/07/06/javadoc-generating-automated-documentation/