#javadoc — Public Fediverse posts
Live and recent posts from across the Fediverse tagged #javadoc, aggregated by home.social.
-
Has modern web documentation made API references worse? Linear pages instead of structured navigation—is that a step backward? Stefan Richthofer explores Javadoc, Doxygen, Sphinx & APIdia to show how API documentation can be easier to browse. Read: https://javapro.io/2026/07/28/meet-apidia-a-new-approach-to-api-documentation-browsing/
#Javadoc #Doxygen Sphinx #APIdia #APIDocumentation APIdia
-
Has modern web documentation made API references worse? Linear pages instead of structured navigation—is that a step backward? Stefan Richthofer explores Javadoc, Doxygen, Sphinx & APIdia to show how API documentation can be easier to browse. Read: https://javapro.io/2026/07/28/meet-apidia-a-new-approach-to-api-documentation-browsing/
#Javadoc #Doxygen Sphinx #APIdia #APIDocumentation APIdia
-
Durch Dinge wie CleanCode oder dem KISS-Prinzip versuchen wir unseren Code möglichst verständlich zu halten. Wir benennen Methoden nachdem was sie tun, wissen, dass eine Methode auch nur eine Sache machen soll und auch die Benamung unserer Variablen sind sprechend. Wer das alles konsequent berück
https://magicmarcy.de/java-doc-–-es-ist-ein-absolutes-muss
#JavaDoc #Dokumentation #Kommunikation #CleanCode #KISS #author #Git #Git_Blame
-
Durch Dinge wie CleanCode oder dem KISS-Prinzip versuchen wir unseren Code möglichst verständlich zu halten. Wir benennen Methoden nachdem was sie tun, wissen, dass eine Methode auch nur eine Sache machen soll und auch die Benamung unserer Variablen sind sprechend. Wer das alles konsequent berück
https://magicmarcy.de/java-doc-–-es-ist-ein-absolutes-muss
#JavaDoc #Dokumentation #Kommunikation #CleanCode #KISS #author #Git #Git_Blame
-
RE: https://mastodon.social/@APIdia/116856260922400209
We are adding GlassFish to APIdia.
HK2 was the first milestone, Grizzly is the next.
On the way, several foundational GlassFish subprojects are added, such as gmbal (GlassFish MBean Annotation Library) and pfl (Jakarta EE Primitive Function Library).hk2: https://apidia.net/mvn/org.glassfish.hk2/hk2
pfl: https://apidia.net/mvn/org.glassfish.pfl/pfl
gmbal: https://apidia.net/mvn/org.glassfish.gmbal/gmbal-project@jakartaee @EclipseFdn @APIdia
#java #javadoc #glassfish #jakartaee #ee4j #eclipsefoundation #OmniFish
-
RE: https://mastodon.social/@APIdia/116856260922400209
We are adding GlassFish to APIdia.
HK2 was the first milestone, Grizzly is the next.
On the way, several foundational GlassFish subprojects are added, such as gmbal (GlassFish MBean Annotation Library) and pfl (Jakarta EE Primitive Function Library).hk2: https://apidia.net/mvn/org.glassfish.hk2/hk2
pfl: https://apidia.net/mvn/org.glassfish.pfl/pfl
gmbal: https://apidia.net/mvn/org.glassfish.gmbal/gmbal-project@jakartaee @EclipseFdn @APIdia
#java #javadoc #glassfish #jakartaee #ee4j #eclipsefoundation #OmniFish
-
GlassFish HK2 is the reference implementation of the jakarta.inject specification within the EE4J project and powers the GlassFish Application Server and the Jersey REST Framework.
Adding HK2 API reference documentation to APIdia is our first milestone for supporting the Eclipse GlassFish ecosystem!https://apidia.net/mvn/org.glassfish.hk2/hk2
https://apidia.net/mvn/jakarta.platform/jakartaee/?cls=jakarta.inject-module#glassfish #eclipse #java #javadoc #apidia #jakarta #ee4j #jakartaee
-
GlassFish HK2 is the reference implementation of the jakarta.inject specification within the EE4J project and powers the GlassFish Application Server and the Jersey REST Framework.
Adding HK2 API reference documentation to APIdia is our first milestone for supporting the Eclipse GlassFish ecosystem!https://apidia.net/mvn/org.glassfish.hk2/hk2
https://apidia.net/mvn/jakarta.platform/jakartaee/?cls=jakarta.inject-module#glassfish #eclipse #java #javadoc #apidia #jakarta #ee4j #jakartaee
-
„Gut dokumentiert“ hilft wenig, wenn Entwickler die Struktur einer API nicht mehr erkennen können. Das kritisiert @Stewori an modernen Doku-Systemen!
Arbeitest du mit großen APIs? Dann lohnt sich der Blick auf #APIdia: https://javapro.io/de/apidia-eine-neue-plattform-fuer-api-dokumentation/
-
„Gut dokumentiert“ hilft wenig, wenn Entwickler die Struktur einer API nicht mehr erkennen können. Das kritisiert @Stewori an modernen Doku-Systemen!
Arbeitest du mit großen APIs? Dann lohnt sich der Blick auf #APIdia: https://javapro.io/de/apidia-eine-neue-plattform-fuer-api-dokumentation/
-
RE: https://mastodon.social/@Stewori/116720397755564355
It's really good to know that Javadoc finally catches up. Of course there will be full support for the new Rich Note tags on our site. Having a standard for this, will make handling admonitions much easier and less error-prone!
-
RE: https://mastodon.social/@Stewori/116720397755564355
It's really good to know that Javadoc finally catches up. Of course there will be full support for the new Rich Note tags on our site. Having a standard for this, will make handling admonitions much easier and less error-prone!
-
RE: https://mastodon.social/@APIdia/115644204111693537
There is a JEP pending to bring admonitions to Javadoc!
https://openjdk.org/jeps/8363700
(They call it "notes" though, but it's effectively the admonition concept as known from tools like Sphinx or AsciiDoc.)
APIdia found its own solution for admonitions in Javadoc some years earlier: -
RE: https://mastodon.social/@APIdia/115644204111693537
There is a JEP pending to bring admonitions to Javadoc!
https://openjdk.org/jeps/8363700
(They call it "notes" though, but it's effectively the admonition concept as known from tools like Sphinx or AsciiDoc.)
APIdia found its own solution for admonitions in Javadoc some years earlier: -
UCanAccess is a pure Java library that provides JDBC read- and write-access to various versions of Microsoft Access databases.
With UCanAccess you can access Access :)
API reference documentation of its latest release 5.1.5 is now on APIdia:
https://apidia.net/mvn/io.github.spannm/ucanaccess
Github: https://github.com/spannm/ucanaccess
Home: https://spannm.github.io/ucanaccess/ -
UCanAccess is a pure Java library that provides JDBC read- and write-access to various versions of Microsoft Access databases.
With UCanAccess you can access Access :)
API reference documentation of its latest release 5.1.5 is now on APIdia:
https://apidia.net/mvn/io.github.spannm/ucanaccess
Github: https://github.com/spannm/ucanaccess
Home: https://spannm.github.io/ucanaccess/ -
Wer große APIs dokumentiert, kennt das Problem: Tutorials funktionieren gut — Referenzdokumentation oft weniger. Orientierung geht verloren. Willst du APIs schneller verstehen? @Stewori analysiert #Javadoc, #Doxygen & Sphinx mit #APIdia.
Lies: https://javapro.io/de/apidia-eine-neue-plattform-fuer-api-dokumentation/
@apidia_net -
Wer große APIs dokumentiert, kennt das Problem: Tutorials funktionieren gut — Referenzdokumentation oft weniger. Orientierung geht verloren. Willst du APIs schneller verstehen? @Stewori analysiert #Javadoc, #Doxygen & Sphinx mit #APIdia.
Lies: https://javapro.io/de/apidia-eine-neue-plattform-fuer-api-dokumentation/
@apidia_net -
RE: https://mastodon.social/@javapro/116633862341336134
For our German-speaking followers:
This Javapro article (in the German Javapro branch) shares some background on our story and design principles.
English version will follow soon! -
RE: https://mastodon.social/@javapro/116633862341336134
For our German-speaking followers:
This Javapro article (in the German Javapro branch) shares some background on our story and design principles.
English version will follow soon! -
„Gut dokumentiert“ hilft wenig, wenn Entwickler die Struktur einer API nicht mehr erkennen können. Genau das kritisiert Stefan Richthofer an modernen Doku-Systemen!
Arbeitest du mit großen APIs? Dann lohnt sich der Blick auf #APIdia: https://javapro.io/de/apidia-eine-neue-plattform-fuer-api-dokumentation/
-
„Gut dokumentiert“ hilft wenig, wenn Entwickler die Struktur einer API nicht mehr erkennen können. Genau das kritisiert Stefan Richthofer an modernen Doku-Systemen!
Arbeitest du mit großen APIs? Dann lohnt sich der Blick auf #APIdia: https://javapro.io/de/apidia-eine-neue-plattform-fuer-api-dokumentation/
-
RE: https://mastodon.social/@APIdia/116561926028932211
Vaadin is one of the most complex projects added to APIdia so far. Did you know that the com.vaadin Maven Central group comprises almost 500 artifacts?
The main parts are covered now: flow, components and hilla. Full integration is WIP, e.g. testbench is still a todo. -
RE: https://mastodon.social/@APIdia/116561926028932211
Vaadin is one of the most complex projects added to APIdia so far. Did you know that the com.vaadin Maven Central group comprises almost 500 artifacts?
The main parts are covered now: flow, components and hilla. Full integration is WIP, e.g. testbench is still a todo. -
TypedMemory is a new, experimental Java library that provides type-safe, structured access to contiguous off-heap memory via Java's new Foreign Function & Memory (FFM) API.
To explore this game changer for data processing in Java, we recommend browsing its API docs on APIdia:
https://apidia.net/mvn/io.github.mambastudio/typedmemoryCredits to Joe Mwangi @joemwangi / Mamba Studio for creating this lib!
Github: https://github.com/mamba-studio/TypedMemory -
TypedMemory is a new, experimental Java library that provides type-safe, structured access to contiguous off-heap memory via Java's new Foreign Function & Memory (FFM) API.
To explore this game changer for data processing in Java, we recommend browsing its API docs on APIdia:
https://apidia.net/mvn/io.github.mambastudio/typedmemoryCredits to Joe Mwangi @joemwangi / Mamba Studio for creating this lib!
Github: https://github.com/mamba-studio/TypedMemory -
Vaadin, *the* go-to solution for Java-based web development, enables writing websites and web applications in 100% pure Java.
We're proud to announce that API documentation of Vaadin is now available on APIdia!
Check it out at https://apidia.net/mvn/com.vaadin/vaadinDocs resemble Javadoc but are more convenient to browse via frame-like side navigation for packages and classes.
They crosslink to almost all dependencies seamlessly. -
Vaadin, *the* go-to solution for Java-based web development, enables writing websites and web applications in 100% pure Java.
We're proud to announce that API documentation of Vaadin is now available on APIdia!
Check it out at https://apidia.net/mvn/com.vaadin/vaadinDocs resemble Javadoc but are more convenient to browse via frame-like side navigation for packages and classes.
They crosslink to almost all dependencies seamlessly. -
JavaDoc finally got a quality-of-life upgrade that actually matters in source code.
I wrote a hands-on tutorial on Markdown JavaDoc in Java 24: /// comments, package docs, records, sealed types, Maven, Javadoc, VS Code hovers, and plain JUnit tests.
This is not about prettier HTML. It is about comments developers and AI tools can read more easily.
#Java #Java24 #Javadoc #Maven #JUnit #DevTools
https://www.the-main-thread.com/p/java-24-markdown-javadoc-maven-tutorial
-
JavaDoc finally got a quality-of-life upgrade that actually matters in source code.
I wrote a hands-on tutorial on Markdown JavaDoc in Java 24: /// comments, package docs, records, sealed types, Maven, Javadoc, VS Code hovers, and plain JUnit tests.
This is not about prettier HTML. It is about comments developers and AI tools can read more easily.
#Java #Java24 #Javadoc #Maven #JUnit #DevTools
https://www.the-main-thread.com/p/java-24-markdown-javadoc-maven-tutorial
-
Are you writing or maintaining an api doc generator for a programming language?
Lots of docs are served straight out of git. Please on't generate commit noise on every generated page.
- Don't generate a version number or time/date onto every page, stick it into the main page at most.
- Alternatively, use a CSS :before or :after rule to generate such content onto every page. Thereby only the changed CSS shows up in the commit.Thanks.
-
API documentation of the recently released Java 26 and JavaFX 26 are available on @APIdia . Keep in mind that for browsing jdk.* modules and jfx.incubator modules you need to adjust the filter settings (see screenshot).
Java26: https://apidia.net/java/OpenJDK/26
JavaFX 26: https://apidia.net/mvn/org.openjfx/javafx/26 -
API documentation of the recently released Java 26 and JavaFX 26 are available on @APIdia . Keep in mind that for browsing jdk.* modules and jfx.incubator modules you need to adjust the filter settings (see screenshot).
Java26: https://apidia.net/java/OpenJDK/26
JavaFX 26: https://apidia.net/mvn/org.openjfx/javafx/26 -
RE: https://mastodon.social/@APIdia/116262485996151434
Adjacent to Java releases are JavaFX releases. Of course, API documentation of JavaFX 26 is similarly available on APIdia:
https://apidia.net/mvn/org.openjfx/javafx/26 -
RE: https://mastodon.social/@APIdia/116262485996151434
Adjacent to Java releases are JavaFX releases. Of course, API documentation of JavaFX 26 is similarly available on APIdia:
https://apidia.net/mvn/org.openjfx/javafx/26 -
Java 26 has been released and likewise, docs on APIdia have been updated:
https://apidia.net/java/OpenJDK/26Enjoy browsing the docs of the new standard library version conveniently with all the features APIdia has to offer!
And of course, big congrats to the OpenJDK team for shipping yet another marvelous Java release!
-
Java 26 has been released and likewise, docs on APIdia have been updated:
https://apidia.net/java/OpenJDK/26Enjoy browsing the docs of the new standard library version conveniently with all the features APIdia has to offer!
And of course, big congrats to the OpenJDK team for shipping yet another marvelous Java release!
-
I'm having a hard time getting used to Markdown JavaDoc in the source code. It's not about the comment text (Markdown helps here), but rather the leading three forward slashes (///).
The eye is so accustomed to the old format. 😩
-
I'm having a hard time getting used to Markdown JavaDoc in the source code. It's not about the comment text (Markdown helps here), but rather the leading three forward slashes (///).
The eye is so accustomed to the old format. 😩
-
Updated the references in my most upvoted #stackoverflow answer to JDK 25.
-
Updated the references in my most upvoted #stackoverflow answer to JDK 25.
-
API documentation of recent releases of Apache Commons Text and Commons Pool are available on APIdia. Docs resemble Javadoc with improved navigation, cross-linking to all dependencies and many other nice features:
https://apidia.net/mvn/org.apache.commons/commons-text
https://apidia.net/mvn/org.apache.commons/commons-pool2 -
API documentation of recent releases of Apache Commons Text and Commons Pool are available on APIdia. Docs resemble Javadoc with improved navigation, cross-linking to all dependencies and many other nice features:
https://apidia.net/mvn/org.apache.commons/commons-text
https://apidia.net/mvn/org.apache.commons/commons-pool2 -
Apache Commons Exec improves external process execution in Java e.g. by better cross-platform support and handling of system variables. API documentation of the recent latest release is best browsed on APIdia with many convenient features:
https://apidia.net/mvn/org.apache.commons/commons-exec -
Apache Commons Exec improves external process execution in Java e.g. by better cross-platform support and handling of system variables. API documentation of the recent latest release is best browsed on APIdia with many convenient features:
https://apidia.net/mvn/org.apache.commons/commons-exec -
Did you know that #APIdia supports admonitions like known from AsciiDoc or Sphinx?
Since #Javadoc lacks admonition tags, a couple of typical HTML patterns is recognized and rendered as proper admonition boxes. See the screenshot for an example (https://apidia.net/java/OpenJDK/?pck=javax.swing&cls=.JComponent).The most common pattern is
<strong>Warning:</strong>text until next<p>
as is shown in the example. Instead of <strong>, also <em>, <b> and <i> are recognized, colon is optional, so
<i>Note</i>text<p>
is also fine. -
Did you know that #APIdia supports admonitions like known from AsciiDoc or Sphinx?
Since #Javadoc lacks admonition tags, a couple of typical HTML patterns is recognized and rendered as proper admonition boxes. See the screenshot for an example (https://apidia.net/java/OpenJDK/?pck=javax.swing&cls=.JComponent).The most common pattern is
<strong>Warning:</strong>text until next<p>
as is shown in the example. Instead of <strong>, also <em>, <b> and <i> are recognized, colon is optional, so
<i>Note</i>text<p>
is also fine. -
RE: https://mastodon.social/@APIdia/115587863622237679
To get started with #JUnit 6 you can explore its API now on #APIdia. Docs largely resemble #JavaDoc but are easier to browse and include the full dependency tree, consistently linked into the docs. Many other nice features to be found. Follow me or @APIdia to learn more.
#java #jvm @junitLatest: https://apidia.net/mvn/org.junit/junit
JUnit 5: https://apidia.net/mvn/org.junit/junit/5
JUnit 4: https://apidia.net/mvn/junit/junit -
RE: https://mastodon.social/@APIdia/115587863622237679
To get started with #JUnit 6 you can explore its API now on #APIdia. Docs largely resemble #JavaDoc but are easier to browse and include the full dependency tree, consistently linked into the docs. Many other nice features to be found. Follow me or @APIdia to learn more.
#java #jvm @junitLatest: https://apidia.net/mvn/org.junit/junit
JUnit 5: https://apidia.net/mvn/org.junit/junit/5
JUnit 4: https://apidia.net/mvn/junit/junit -
API documentation of #JUnit 6 is now available on #APIdia. All artifacts of the latest release are conveniently browsable in one coherent doc profile. All dependencies are available as well and consistently linked to all occurrences in the API docs. Enjoy browsing!
https://apidia.net/mvn/org.junit/junit/6 -
API documentation of #JUnit 6 is now available on #APIdia. All artifacts of the latest release are conveniently browsable in one coherent doc profile. All dependencies are available as well and consistently linked to all occurrences in the API docs. Enjoy browsing!
https://apidia.net/mvn/org.junit/junit/6 -
RE: https://mastodon.social/@APIdia/115491379991389613
API doc of the third major release of the Jackson data processor can be browsed on APIdia now.
This alternative to #Javadoc is perfect for those who preferred browsing Javadoc with frames and has other advantages too, e.g. all hosted projects are fully crosslinked. #java -
RE: https://mastodon.social/@APIdia/115491379991389613
API doc of the third major release of the Jackson data processor can be browsed on APIdia now.
This alternative to #Javadoc is perfect for those who preferred browsing Javadoc with frames and has other advantages too, e.g. all hosted projects are fully crosslinked. #java -
API documentation of #Gradle 9.2.0, the most recent release of the well-known build tool, is now available on APIdia. The gradle-api-tooling artifact offers programmatic access to Gradle and APIdia is the best place for browsing its rich API conveniently:
https://apidia.net/mvn/org.gradle/gradle-tooling-api -
API documentation of #Gradle 9.2.0, the most recent release of the well-known build tool, is now available on APIdia. The gradle-api-tooling artifact offers programmatic access to Gradle and APIdia is the best place for browsing its rich API conveniently:
https://apidia.net/mvn/org.gradle/gradle-tooling-api -
Jackson 3 API documentation is now available on APIdia:
https://apidia.net/mvn/tools.jackson/jackson/3
It's always amazing to see a major version bump getting shipped, especially from a backbone project of the Java ecosystem such as the Jackson data processor!
#java #javadoc #apidia -
Jackson 3 API documentation is now available on APIdia:
https://apidia.net/mvn/tools.jackson/jackson/3
It's always amazing to see a major version bump getting shipped, especially from a backbone project of the Java ecosystem such as the Jackson data processor!
#java #javadoc #apidia -
#JabRef 6.0-alpha.3 has been released! Congrats to @jabref for this new milestone!
Our contribution to JabRef is hosting the API documentation and of course, the new docs are readily available:
https://apidia.net/java/JabRef/6.0-alpha.3
#java #javadoc
https://blog.jabref.org/2025/10/30/JabRef6-0-alpha3/ -
#JabRef 6.0-alpha.3 has been released! Congrats to @jabref for this new milestone!
Our contribution to JabRef is hosting the API documentation and of course, the new docs are readily available:
https://apidia.net/java/JabRef/6.0-alpha.3
#java #javadoc
https://blog.jabref.org/2025/10/30/JabRef6-0-alpha3/ -
Now I learned that you can include parts of a source file into Javadoc with
{@snippet file=SomeSource.java}
and this since JDK-18. Yet it took only a very short time to notice that something important is missing:😩