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:

#java #javadoc #apidia #jvm

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/

#java #jdbc #javadoc #apidia

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!

#javapro #java #javadoc #apidia

„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/

#Doxygen #Javadoc

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.

#vaadin #apidia #javadoc #java #jvm

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/typedmemory

Credits to Joe Mwangi @joemwangi / Mamba Studio for creating this lib!
Github: https://github.com/mamba-studio/TypedMemory

#apidia #java #javadoc #jvm

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/vaadin

Docs 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 #apidia #java #javadoc #jvm

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.

#typedoc #javadoc #pydoctor #apidoc #doxygen