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

All new files my old `btrfs` filesystem creates are above 32-bit inode space:

$ touch a && stat '-c%i' a
11833717710

Very occasionally I build 32-bit `i686-linux` packages. Sometimes they fail to run against file with so large inodes.

Two casualties today:
- `doxygen`: https://github.com/doxygen/doxygen/pull/11518
- `graphviz`: https://gitlab.com/graphviz/graphviz/-/merge_requests/4269

The @kde community has an ongoing effort to port its documentation from Doxygen to QDoc, and you can help with that.

Join us tomorrow (14/11) starting at 1PM (UTC) at: https://matrix.to/#/!KfwuSDyCBkcbRESeSA:kde.org?via=kde.org&via=matrix.org&via=private.coffee

More info:
https://blogs.kde.org/2024/11/13/api-documentation-porting-sprint/

@debacle @alienghic I wish there was a package for those projects that use #Doxygen or those that #Qt's #QDoc.
Some projects such as KDE use docbooks, there's a rudamentary mode for them:
https://elpa.gnu.org/packages/docbook.html

With doxygen , Qt or Pythons API doc doc the documentation often doesn't really look like a manual like in Info mode I think there
should be a separate mode for such to view them or something that makes them easier to view in a single page per object.

The s390x open source team at IBM confirms the latest versions of various software packages run well on #Linux on #IBMZ & #LinuxONE

In June 2024 validation was maintained for over 30 projects, including: #CockroachDB #doxygen & #HashiCorp's #Terraform

Also, the AI/ML team at #IBM did initial work focused on s390x compatibility for Mage AI & the Triton Inference Server received compatibility fixes for big endian platforms.

Full report at: https://community.ibm.com/community/user/ibmz-and-linuxone/blogs/elizabeth-k-joseph1/2024/07/19/linuxone-open-source-report-june-2024

Getting #Doxygen to output markdown for API documentation is a pain. With some tweaking of an old conversion tool, I managed to get something acceptable working. #DevRel #programming #cpp

@wolfram_roesler running #doxygen helps at least to find issues with the comments. For instance, I refactored a method but forgot to also update the parameter descriptions. Here, doxygen bemoaned this mismatch correctly.

Some first steps to integrate #doxygen in my #opensource project. Feels ok so far. There are only some hiccups resolving references.

typical doxygen user experience in 2024

The s390x open source team at IBM confirms the latest versions of various software packages run well on #Linux on #IBMZ. In January 2024 validation was maintained for nearly 40 projects, including: #ApacheSolr #doxygen & #rethinkdb

Full report: https://community.ibm.com/community/user/ibmz-and-linuxone/blogs/elizabeth-k-joseph1/2024/02/13/linuxone-open-source-report-january-2024 #LinuxONE #mainframe #OpenSource

New use case for #GitHubCopilot : auto generation of documentation. Since it seems to work better, "understanding code" (based on its ability to explain it), point and click on the function text (not generated by Copilot in the examples I am working with) and ask it to give you back #doxygen comments. Tested in #Clang, will try #POD with #Perl @Perl

Thinking about automation of documentation for error messages from Linux based app written in #C. Something like #Doxygen, but it doesn't go into function bodies. Need something that will go into function body and look for comments ahead of the calls which display errors. The tool collects these to provide documentation on impact and user action related to the available messages.

Seen something like this?

Or other ways to manage this content?

Keeping msgs and docs in sync by hand is a pain.

I'm looking for opinions on function API doc strings for C and C++. I know that python has a well-defined approach. For C/C++ I have been using doxygen, but emacs support has waned: doxymacs has been unmaintained for ages.
Is there any new and widely supported approach you would recommend for C and C++? Or is there an upcoming revival of support for doxygen in emacs?
#Emacs #c++ #doxygen

I am searching for the KDE of automated source project documentation

Doxygen is the Gnome of automated source project documentation and I have spent all night becoming an expert to have a refined opinion of hating it now

Doxygen Quick Reference Doxygen Commands
(2010) : Anon
url: https://www.doxygen.nl/index.html
#doxygen #cheat_sheet #technical #reference #my_bibtex