„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

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

https://pjotrek-b.github.io/Knowledge/doxygen_omekas

Put a pre-rendered copy of a freshly generated #OmekaS source code documentation in HTML.

Thanks #doxygen, and #omeka people!

Is there any way to convince Doxygen to use properly structured HTML tags?

By default Doxygen:
- Uses <div class="title"> instead of <h1> (and <h1> instead of <h2> etc.)
- Images are weird: They are placed in <div class="image">, and a <div class="caption"> (HTML has <figure> and <figcaption for this!) is used for the caption.
- All images have alt="", and the Alt-Text from Markdown is used as a caption instead.  

#doxygen #accessibility

Recently, we talked about #libid3tag and our intent to make a new release. So far, we have a preview of some changes that have already been made in the latest main:

- Mojibake fixes for #UTF-16 (no BOM) encoded fields.
- Some code cleanups, including warning fixes.
- Compatibility with #CMake > 4.0 (we now require CMake 3.10+)

Meanwhile, we are also working on #Doxygen documentation to better document the library too, so quite a few things are going on for libid3tag right now.

I'm working on a project which includes files written in both C and #Lisp; I'd like to have a common documentation generator for the whole project, to generate integrated documentation.

Has anyone made #Doxygen work with Lisp? Are there any recommendations for a documentation generator which can work for both (and also Markdown, which is what my specification docs are written in?

Having to deprecate a part of #poser's API for the first time, I added support for the #deprecated attribute supported by #GCC and #clang and then found #Doxygen couldn't automatically use it.

I didn't want to document deprecation *twice*, so I came up with a little hackery, see screenshots. 🙈

It's not perfect, requiring to type the message in plain text as a macro argument forbids the usage of a comma 😉 But hey, it works!

https://zirias.github.io/poser/api/latest/deprecated.html

#C #coding