[poppler] QT4, API documentation

[Stefan Kebekus]

Hi,

I have started to write a bit of documentation, which I attach to this mail. 
Please commit if you like it (the 'Mainpage.dox' goes to the 
qt4/src-directory, the 'doxywizard' stripped the documentation off the 
Doxyfile, but since everything is well-documented in the wizard, I think 
that's ok).

I had another look at the splashRenderToPixmap method, and I have a few 
question about that

* The API looks a bit absurd. Do you think it can still be changed, or do we 
have to maintain binary compatibility? If not, I would remove the argument 
"QPixmap **q", and simply return a QPixmap. 

* I assume that the method can fail in some circumstances. Is failure 
indicated in any way?

* It seems to me that none of the arguments "x, y, w, h" is ever used. Shall 
we use them, or shall we just remove them?

Best,

Stefan.
-- 
Maintainer of KDVI

http://devel-home.kde.org/~kdvi
-------------- next part --------------
A non-text attachment was scrubbed...
Name: poppler-doc.diff
Type: text/x-diff
Size: 53462 bytes
Desc: not available
Url : http://lists.freedesktop.org/archives/poppler/attachments/20051129/91c9fe52/poppler-doc-0001.bin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Mainpage.dox
Type: text/x-objcsrc
Size: 2278 bytes
Desc: not available
Url : http://lists.freedesktop.org/archives/poppler/attachments/20051129/91c9fe52/Mainpage-0001.bin