10
API documentation porting sprint (blogs.kde.org)
submitted 1 week ago by frdbr@lemmy.kde.social to c/kde@lemmy.kde.social
1 comments fedilink hide all child comments

It was once said over the grapevine that: "Our C++ API documentation has some issues, our QML API documentation has a lot of issues."

And it was true, but that is to change soon! As you might know, there is an ongoing effort to port our documentation from Doxygen to QDoc, and you can help with that.

This is a task that has been adopted by the Streamlined Application Development Experience championed by Nicolas Fella and Nate Graham as part of the KDE Goals initiative.

We would like to invite you to join our porting sprint effort to finish this task. On November 14th at 1PM UTC, we'll be hanging out in the Matrix room working on this. Hope to see you there.

Some prerequisites:

  • Ability to use a terminal
  • Extra disk space (30GB minimum)
  • Some familiarity with APIs

Check out the instructions prepared by Thiago Sueto on how to get started porting a project to QDoc.

top 1 comments
sorted by: hot top controversial new old
[-] onlinepersona@programming.dev 0 points 1 week ago

Extra disk space (30GB minimum)

Holy shit. Are they generating documentation or a game?

On November 14th at 1PM UTC

Looks like the announcement was written by somebody from the US and the picture made by somebody non-US.

Anti Commercial-AI license

this post was submitted on 13 Nov 2024
10 points (100.0% liked)

KDE

5336 readers
61 users here now

KDE is an international technology team creating user-friendly free and open source software for desktop and portable computing. KDE’s software runs on GNU/Linux, BSD and other operating systems, including Windows.

Plasma 6 Bugs

If you encounter a bug, proceed to https://bugs.kde.org, check whether it has been reported.

If it hasn't, report it yourself.

PLEASE THINK CAREFULLY BEFORE POSTING HERE.

Developers do not look for reports on social media, so they will not see it and all it does is clutter up the feed.

founded 1 year ago
MODERATORS
carlschwan@lemmy.kde.social
Bro666@lemmy.kde.social
herzenschein@pawb.social
Aniqakhokhar@lemmy.kde.social