[Development] No implementation hints in Qt Documentation

Thiago Macieira thiago.macieira at intel.com
Thu May 3 14:41:55 CEST 2012

On quinta-feira, 3 de maio de 2012 13.30.12, Richard Moore wrote:
> One thing we've been doing in the network subsystem is adding
> information to the wiki pages about how things fit together. Olivier
> has done the same thing for QStringBuilder and QMutex too. I think
> having more information like this would be a good way to make it
> easier for people to navigate the source tree.
> http://qt-project.org/wiki/PortalQt-Internals

Make sure that the code has links back to the wiki. Otherwise it's going to 
get stale when someone updates the code and has no clue the information is in 
the wiki.

Like I was bound to do for the QMutex part.

IMHO, the developer documentation should be in the code, like for 

Thiago Macieira - thiago.macieira (AT) intel.com
  Software Architect - Intel Open Source Technology Center
     Intel Sweden AB - Registration Number: 556189-6027
     Knarrarnäsgatan 15, 164 40 Kista, Stockholm, Sweden
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 190 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.qt-project.org/pipermail/development/attachments/20120503/afd642f8/attachment.sig>

More information about the Development mailing list