Trolltech Home | Qt-interest Home | Recent Threads | All Threads | Author | Date
All threads index page 4

Qt-interest Archive, April 2008
generating qt assistent help files from code comments?

Message 1 in thread

hi,

I see that the Qt class documentation is generated from code comments. For
open source qt programs, good code documentation is equally  important as
good software documentation. Is the tool to extract these comments publicly
available?

seems like it would be double work to make a publicly available version if
trolltech has this already, not?

greets
naja
Message 2 in thread

Have a look at Doxygen:
http://www.stack.nl/~dimitri/doxygen/

this has been discussed before on this list:
http://lists.trolltech.com/qt-interest/2006-11/msg00487.html

Cheers,
Peter 

> -----Ursprüngliche Nachricht-----
> Von: Naja Melan [mailto:najamelan@xxxxxxxxx] 
> Gesendet: Montag, 21. April 2008 17:56
> An: qt-interest@xxxxxxxxxxxxx
> Betreff: generating qt assistent help files from code comments?
> 
> hi,
> 
> I see that the Qt class documentation is generated from code 
> comments. For open source qt programs, good code 
> documentation is equally  important as good software 
> documentation. Is the tool to extract these comments publicly 
> available?
> 
> seems like it would be double work to make a publicly 
> available version if trolltech has this already, not?
> 
> greets
> naja
> 
> 

--
 [ signature omitted ]
Message 3 in thread

On Monday, 21.04.2008 18:56:11 Naja Melan wrote:

> Is the tool to extract these comments publicly available?

google://doxygen

Attachment:

Attachment: smime.p7s
Description: S/MIME cryptographic signature

Message 4 in thread

sorry, i should have searched the archives... That thread says it all...
Message 5 in thread

Naja Melan wrote:
> sorry, i should have searched the archives... That thread says it all...

Starting with 4.4, we're also shipping qdoc3 as part of Qt now (this is the
tool that we use to generate the documentation).

-- 
 [ signature omitted ]