[prev in list] [next in list] [prev in thread] [next in thread] 

List:       koffice-devel
Subject:    koffice API docs
From:       Thomas Zander <zander () kde ! org>
Date:       2006-06-11 10:47:18
Message-ID: 200606111247.20559.zander () kde ! org
[Download RAW message or body]

[Attachment #2 (multipart/signed)]


I personally really appreciate good API docs; since they speed up my way 
of working quite a bit.
With docs generation we had in svn being broken for some time now I 
figured it was a good time to write a little script that creates doxygen 
apidocs for koffice.

Major issues I had with the ones from ktown or EBN was first of all that 
the markup was pretty, but very hard to use as a reference doc.
It also left out inter-project linking; so I could not get to KoDocument 
from the KWDocument class docs.
Both of which I fixed.  I would really appreciate it if efforts to make 
the docs conform to KDE blue were thus NOT undertaken :)

If you have a (quite) recent doxygen installed you can create docs simply 
by going into koffice (trunk) and typing:
doc/api/gendocs.pl

Which will generate docs in separate dirs in doc/api/

I would invite people to add a Mainpage.dox to their project dir with 
contents like:
  /**
 * \mainpage
 * TODO Introduction + major classes + code examples
 */

After which it will appear as a new dir under doc/api/

Have fun!
-- 
Thomas Zander

[Attachment #5 (application/pgp-signature)]

_______________________________________________
koffice-devel mailing list
koffice-devel@kde.org
https://mail.kde.org/mailman/listinfo/koffice-devel


[prev in list] [next in list] [prev in thread] [next in thread]