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
QSharedPointer.

--
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

Attachment: signature.asc
Description: This is a digitally signed message part.

_______________________________________________
Development mailing list
[email protected]
http://lists.qt-project.org/mailman/listinfo/development

Reply via email to