API Docs

Daniel Vrátil dvratil at redhat.com
Mon Mar 25 09:10:49 UTC 2013


On Friday 22 of March 2013 11:47:17 David Edmundson wrote:
> We now have API Docs are available from:
> 
> http://static.davidedmundson.co.uk/ktpdocs/namespaceKTp.html

Nice! Could you ask sysadmins to add KTp to api.kde.org? I /think/ it syncs 
automatically from time to time.

> 
> Please, start contributing more API documentation.
> For adding docs I'm happy with people skipping reviews, just commit
> directly unless you're not sure of anything.
> 
> Ping me and I will update the documentation here.
> 
> Does anyone know of any documentation checkers? One that makes a list
> of methods that don't have documentation and such.

Add these to doxygen configuration:

WARNINGS          = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC  = YES

Dan

> 
> David
> _______________________________________________
> KDE-Telepathy mailing list
> KDE-Telepathy at kde.org
> https://mail.kde.org/mailman/listinfo/kde-telepathy
-- 
Daniel Vrátil
Associate Software Engineer, KDE Desktop Team
Red Hat, Inc

GPG Key: 0xC59D614F6F4AE348
Fingerprint: 4EC1 86E3 C54E 0B39 5FDD B5FB C59D 614F 6F4A E348
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 490 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/kde-telepathy/attachments/20130325/73101499/attachment.sig>


More information about the KDE-Telepathy mailing list