Re: Api Documentation and KDevelop
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
On Montag, 6. Januar 2003 20:54, Dirk Schmidt wrote:
> I wrote:
> > [Doxygen KDE API Doc in Kdevelop]
> > I already took a look at KDevelop's source and AFAIS KDevelop needs at
> > least index files in kdoc format.
> > I wonder, if there's any tool (e.g. some little script) to convert the
> > those Doxgen XML tag files to kdoc style index files?
>
> Ok, I did it. With a very dirty hack in c++ I parsed the .tag files in
> /usr/share/doc/kde/html/en/kdelibs-apidocs from Doxygen and converted them
> with some little manual editings in .kdoc style files and put them in
> ~/.kdoc. I now had just had to create an
> /usr/share/doc/kde/html/en/kdelibs-apidocs/kdecore/index.html and insert
> [Doc_Location]
> doc_kde=/usr/share/doc/kde/HTML/en/kdelibs-apidocs/
> to kdeveloprc.
>
> If anybody wants, I can e-mail him my .kdoc files (~300kb).
>
> Ralf, maybe you could take a look at this and include it to the kdevelop
> debs, if you guess my way is decent and you don't know any other or better.
Could be used for now, though I'm unhappy with it. It's more dirty than a
dirty hack, because what is desireable is to change the way that
doctreeview.cpp parses .kdoc files. It should be enabled to either kdoc or
tag files, so the modification needs to happen there.
I would be more than happy to include a fix in the kdevelop sourcetree to
enable the treeviewer to parse either, this will finally solve all problems
for the doxygen documentation and will also enable app developers to view
their own API's also without crude hacks.
If you need any assistance with that, let me know. I would surely be thankful
for hacking up doctreeview.cpp in kdevelop. Please get the 2.1.4 sourcetree
or the KDE_2_2_BRANCH kdevelop and exchange kdevelop/admin against
kde-common/admin from HEAD to make it work (or just grab the sources from the
KDE-3.0.5a release with apt-get source). I'll also repackage this, as long as
it cleans this up in a way that the work doesn't have to happen over and over
again with following releases in KDE for API documentation generation.
Ralf
>
> Dirk
- --
We're not a company, we just produce better code at less costs.
- --------------------------------------------------------------------
Ralf Nolden
nolden@kde.org
The K Desktop Environment The KDevelop Project
http://www.kde.org http://www.kdevelop.org
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)
iD8DBQE+GpSdu0nKi+w1Ky8RArzUAJ91iAn4s3tIcVL3KYWWwcbJsKURIwCfQYNV
daaVIaYejIVA5cKfdc1NDZU=
=gqi/
-----END PGP SIGNATURE-----
Reply to: