[Kde-pim] New API documentation for messageviewer

[Stephen Kelly]

Thomas McGuire wrote:

> Hi,
> 
> I've added API documentation for the messageviewer library in r1084926.
> It describes the viewer in depth, especially how the ObjectTreeParser
> works. This will make understanding this library much easier, hopefully.
> 
> I would appreciate any feedback on the new documentation, especially from
> those who already have worked with the library.
> 
> Finally, I need some help to fight with Doxygen: The documentation for
> ViewerPrivate didn't turn up in the generated HTML at all, any idea why?

Because the files end in _p.h. The private files are filtered out. Allen 
probably knows if it can be included anyway.

> Also, most of the classes and functions are not linked. Maybe this is
> related to namespaces?

I used a trick in grantlee Mainpage.dox of putting the content in the 
Grantlee namespace. I don't think it's the correct solution, but it works.

http://gitorious.org/grantlee/grantlee/blobs/master/Mainpage.dox

> Please help if you know Doxygen.
> 
> Regards,
> Thomas


_______________________________________________
KDE PIM mailing list kde-pim at kde.org
https://mail.kde.org/mailman/listinfo/kde-pim
KDE PIM home page at http://pim.kde.org/