cppsupport extension

Jonas B. Jacobi jonas.jacobi at web.de
Tue May 20 20:46:06 UTC 2003


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hey ho folks!
I wrote an extension for the cppsupportpart, which extends the pcs database 
with the ability to store doxygen documentation to functions in it, and show 
this documentation on codecompletion. An example with kdelibs can be seen at
http://www.informatik.uni-oldenburg.de/~rischwa/codedocu1.jpg .
It still isn't complete and has problems on some special doxygen tags(as a 
result "no documentation available!" is shown on some functions, although 
there is some available), but i will hopefuly solve that the next days.
It works with the xml files, doxygen can generate out of comments. To use it, 
you have to provide the xmlfiles to r++. Here a little howto:
(1) generate xml files. You do this, by adding "GENERATE_XML = YES" (without 
quotations) to the file 'Doxyfile' (located in the toplevel dir of the 
project) and then run doxygen in the toplevel dir. Doxygen creates a 
directory named "xml" in the toplevel dir.
(2) (re)create pcs databases using r++. You do this by running r++ like you 
did before, but with the difference that you have to provide the xml 
directories containing the documentation refering to the parsed files to r++.
This is done via the commandline switch -d.
I'll give an example, i ran r++ like this, while my kdelibs snapshot was 
located in /home/jonas/tmp/kdelibs:

r++ kdelibs -r -f -d/home/jonas/tmp/kdelibs/xml /home/jonas/tmp/kdelibs/

You can specify more than one directory for documentation by providing 
multiple -d switches. Notice that there is _no_ whitespace between '-d' and 
the directory.
After that you have to restart gideon, to let changes take place and don't 
forget to delete your old pcs databases, if you created a new one. For those 
of you, this is too complicated to: i'm currently writing a gui for r++ and 
hope to finnish that soon ;).

Yours,
Jonas (Rischwa|5r on #kdevelop in irc.kde.org)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.2 (GNU/Linux)

iD8DBQE+ynez+DjDRZnztNYRAs3OAJ9rGc0IhWXUOnTNnNzaZ3ZhgOCCVQCfZwqb
2KtUc7bjT60eOvqapJFgZ8Q=
=j+NQ
-----END PGP SIGNATURE-----
-------------- next part --------------
A non-text attachment was scrubbed...
Name: cppsupportpart.patch.bz2
Type: application/x-bzip2
Size: 3058 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/kdevelop-devel/attachments/20030520/9b5a0c16/attachment.bin>


More information about the KDevelop-devel mailing list