kdevplatform API docs
Tomáš Trnka
tomastrnka at gmx.com
Tue Nov 11 09:32:06 GMT 2025
Hi,
I'm making my first baby steps in KDevelop development, prototyping a new
language support plugin (Fortran, based on flang; for fun and profit :-)). As
a complete newcomer to the codebase, I feel that the whole DUChain world has
quite a learning curve and it take a while to figure out how things work.
The kdevplatform codebase is full of nice and helpful Doxygen comments, but I
can't for the life of me build a browsable version (be it Doxygen HTML or
QtHelp or anything else) or find it anywhere. There are some dead links to
api.kde.org around on the internet, but that's about it.
So what do you people use as the source of kdevplatform API documentation?
I have so far relied on browsing the source directly and reading the comments
there, combined with a bit of reverse-engineering of the existing clang cpp
support to figure out how all the bits go together, but that gets kinda
tedious. A clickable hyperlinked version of the docs with inheritance diagrams
and indices and everything would be so much more efficient.
There is a Doxyfile in the repo, but that doesn't build at all for me. Some
required files like doc/api/common/header.html were deleted quite a while ago:
commit 70a6358443530e13356e78f890a2403fa55ceeff (tag: v4.2.90)
Author: Milian Wolff <mail at milianw.de>
Date: Fri Feb 24 16:47:03 2012 +0100
remove outdated documentation that is not built anyways and hence just
clutters out release tarballs
(Yes, I tried reverting that commit, but that just uncovers other missing
files.)
If the current state is that there's no browsable API docs at all and all we
have are the comments, would it be welcome if I went and resurrected the
Doxygen build support, or are you fundamentally opposed to that?
By a weird coincidence, looks like I'm not even the only person looking for
the docs in this month:
https://discuss.kde.org/t/looking-for-kdevplatform-docs/41046
Best,
Tomáš
More information about the KDevelop-devel
mailing list