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

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

#doxygen #graphviz #bug

🚀 New release for OpenYuusha! Mostly gruntwork... but LOOK MA, AN OPEN FILE WINDOW! And some pretty documentation for the underlying library... 🌺

https://gitlab.com/lenaing/open-yuusha/-/blob/main/CHANGELOG.md#010-alpha2---2024-12-07

#imgui #doxygen #reverseengineering #cppdev #meson #rpgmaker95 #rpgmaker

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/

#cpp #kde #documentation #doxygen #kdegoals #qt #api #qdoc

TAB vs SPACE in C code ....

They taught me to use tabs 20 years ago, so I stayed with it in private projects.
Having one char for indentation feels more correct for me too.

But #VSCode fails to interpret #doxygen comments correctly if TABs
are involved. Doxygen output is fine, but my beloved on-mouse-over help is not.

So what?
Ignore SPACE-trends, convert doxygen-comments to spaces only or convert all to spaces (including some fun with GIT)?

I don't know what i want. 😫

Правильный путь создания python-библиотеки: от создания до публикации

Привет, Хабр! Стоит ли говорить, что Python ОЧЕНЬ и ОЧЕНЬ популярный язык программирования, местами даже догоняя JavaScript. Python в мире программирования — это эсперанто, легкий язык созданный для всех, но его владельцам не мешало бы помыться. В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: «А почему мне бы не создать свою полноценную библиотеку?», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания своих python-библиотек. Я полностью расскажу все этапы создания библиотеки: документация, тестирование, архитектура, публикация и управление зависимостями Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/847370/

#python #poetry #pyproject #документация #doxygen #тестирование #unittest #pytest #библиотека #timeweb_статьи

Создаем свою простую (C++) библиотеку с документацией, CMake и блекджеком

В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: ‭«А почему мне бы не создать свою полноценную библиотеку?‭», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания проектов, и не только библиотек. Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/845074/

#C++ #doxygen #open_source #github #библиотека #туториал #создание_библиотеки #создание_проекта #cmake

@debacle @alienghic@octodon.social 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

I wish there was something for #vim where I could hit a key combination and popup a C function prototype from my own code describing its use from my #Doxygen comments...

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.

#programming #CPlusCplus #foss #cpp

@dazfuller have you looked at https://www.doxygen.nl/ for producing HTML documentation from .NET code?

#doxygen #dotnet

... 100+ C header file updates just to include them on the next #doxygen run ... 😪

Coding is fun, documentation isn't. Where is the #AI bot to take that job?

But I have learned, that documentation is another form of code review and especially concept review.
I always find bugs, when I write down what a function "should" do in human words.

It's like a training the most important neural network: my own brain 😁

And surprise: #doxygen v1.10 has dark-mode support now. 👍

@runevision Just to throw it out there - if you want a more modern look & feel to the generated docs, check out Doxygen Awesome:

https://github.com/jothepro/doxygen-awesome-css

#doxygen #documentation #CSS

typical doxygen user experience in 2024

#doxygen

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

Here's a simple proof of concept, that I might develop into something more usable in the future.

https://github.com/eXpl0it3r/DoxygenCompare

#FOSS #api #doxygen

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