[Qt-interest] writing documentation

[Lorenzo Bettini]

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... 
but I don't find documentation anywhere...

Matteo Bertozzi wrote:
> The qdoc source code is here:
> http://qt.gitorious.org/qt/qt/trees/master/tools/qdoc3
> 
> 
> On Mon, May 18, 2009 at 2:38 PM, Lorenzo Bettini <bettini at dsi.unifi.it 
> <mailto:bettini at dsi.unifi.it>> wrote:
> 
>     Lorenzo Bettini wrote:
>      > Oliver.Knoll at comit.ch wrote:
>      >> Lorenzo Bettini wrote on Monday, May 18, 2009 9:08 AM:
>      >>
>      >>> ... for documenting API for a qt program/library I'm using doxygen,
>      >>> but what about the manual?  I've always been using texinfo for
>      >>> writing manuals, but what is the "qt way"?  docbook?  Simple HTML?
>      >>> or something else?
>      >> Interesting question: a "Qt way" for writing printed documentation?
>      >> Back in university time I used Framemaker for writing my diploma
>     work
>      >> ;) But most people here will probably use something like Word or
>      >> OpenOffice for their printed documentation.
>      >>
>      >
>      > well, for instance, GNU programs usually require info manuals,
>     thus you
>      > usually use texinfo.
>      >
>      > For KDE, I think they use docbook...
>      >
>      > with this tools you can have something that can be printed, or simple
>      > html that can be browsed, and you write your stuff only using one
>     format.
>      >
>      >> By the way, if you are referring to an "online manual", then Qt also
>      >> offers http://doc.qtsoftware.com/4.5/qthelp.html. I think nowadays
>      >> the "Qt Assistant" based help browser uses WebKit, so you can
>     use the
>      >> latest and greatest (X)HTML :) - Previously it was merely a
>      >> "sufficient subset of HTML 4.0" (or even 3.2 only?).
>      >
> 
>     By the way, I've also heard about qdoc, but I can't find any link in the
>     documentation to this tool/format...
> 
>     --
>     Lorenzo Bettini, PhD in Computer Science, DI, Univ. Torino
>     ICQ# lbetto, 16080134     (GNU/Linux User # 158233)
>     HOME: http://www.lorenzobettini.it MUSIC: http://www.purplesucker.com
>     http://www.myspace.com/supertrouperabba
>     BLOGS: http://tronprog.blogspot.com  http://longlivemusic.blogspot.com
>     http://www.gnu.org/software/src-highlite
>     http://www.gnu.org/software/gengetopt
>     http://wwwgnu.org/software/gengen
>     <http://www.gnu.org/software/gengen> http://doublecpp.sourceforge.net
> 
>     _______________________________________________
>     Qt-interest mailing list
>     Qt-interest at trolltech.com <mailto:Qt-interest at trolltech.com>
>     http://lists.trolltech.com/mailman/listinfo/qt-interest
> 
> 


-- 
Lorenzo Bettini, PhD in Computer Science, DI, Univ. Torino
ICQ# lbetto, 16080134     (GNU/Linux User # 158233)
HOME: http://www.lorenzobettini.it MUSIC: http://www.purplesucker.com
http://www.myspace.com/supertrouperabba
BLOGS: http://tronprog.blogspot.com  http://longlivemusic.blogspot.com
http://www.gnu.org/software/src-highlite
http://www.gnu.org/software/gengetopt
http://www.gnu.org/software/gengen http://doublecpp.sourceforge.net