[Qt-interest] writing documentation

[Andreas Pakulat]

On 18.05.09 21:55:06, Lorenzo Bettini wrote:
> Andreas Pakulat wrote:
> > On 18.05.09 15:39:44, Lorenzo Bettini wrote:
> >> yes, but these are the sources... I was looking for a manual page 
> >> concerning qdoc, its format, how to use it... I see that it is often 
> >> used in some qt projects, so it looks like a kind of standard format... 
> > 
> > In Projects that were developed inside QtSoftware maybe, qdoc(3) was
> > internal to QtSoftware until Qt4.4 (IIRC, or is it only in Qt4.5?) when
> > they decided to ship it along with the rest. So this means its not a
> > standard format, however one of the standards is based on the format
> > that qdoc supports, namely doxygen. If you look at the Qt sources and
> > you know doxygen you'll quickly see the similarities. And if you look
> > into that directory in the README.txt you'll see that even QtSoftware
> > suggests to use doxygen instead of qdoc.
> 
> Yes, but again I'm already using doxygen for APIs but I needed something 
> for a complete manual...  as far as I understand I could go with html 
> directly for the manual

Well, the Qt designer manual is written with qdoc, so in theory doxygen
can write manuals. Not sure if its really feasible though. If you want
something thats a bit more geared towards printing/dtp I suggest to
either use tex or docbook, both of which can convert to pdf/html rather
easily.

Andreas

-- 
Try the Moo Shu Pork.  It is especially good today.