[Qt-creator] Request for comments.... help... QtCreator tutorial

[Miettinen Riitta-Leena]

Well, as there is already a placeholder in the existing documentation for your example topic, I don't see why you would be opposed to writing it in QDoc and submitting a patch to the qtcreator repository. If you find it difficult to get started, I could even create the file for you.

Cheers,

Leena

--------------------------------------------------------------------------------------------------------------------------------
Leena Miettinen, Documentation Engineer - Digia, Qt

Digia Germany GmbH
Rudower Chaussee 13, 12489 D-Berlin
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B,
Geschäftsführer: Mika Pälsi, Juha Varelius, Anja Wasenius
Email: riitta-leena.miettinen at digia.com<mailto:forename.surname at digia.com>
Mobile: +49 16097202682
http://qt.digia.com<http://qt.digia.com/>
Qt Blog: http://blog.qt.digia.com/
Qt Facebook: www.facebook.com/qt<http://www.facebook.com/qtcommercial>
Qt Twitter: www.twitter.com/qtcommercial<http://www.twitter.com/qtcommercial>

Digia Germany is a group company of Digia Plc,
Valimotie 21, FI-00380 Helsinki Finland
Visit us at: www.digia.com<http://www.digia.com/>
------------------------------------------------------------------
PRIVACY AND CONFIDENTIALITY NOTICE
This message and any attachments are intended only for use by the named addressee and may contain privileged and/or confidential information. If you are not the named addressee you should not disseminate, copy or take any action in reliance on it. If you have received this message in error, please contact the sender immediately and delete the message and any attachments accompanying it. Digia Germany GmbH and Digia Plc do not accept liability for any corruption, interception, amendment, tampering or viruses occurring to this message.



On Sep 5, 2013, at 11:16 PM, Guido Seifert wrote:


I am certainly not opposed to have a bit of exposure on SO, but for the
purpose of documentation it sounds rather odd.

Seems to be accepted on SO. And it looks like I am not the first with this idea. Though I must admit, that I still wait and see, if my post is closed for some obscure reason, before I add another one.

You gave yourself a perfect example that even high-quality documentation
bit-rots rather quickly if it is not kept close to and maintained
together with the source.

Yes.... but honestly, the documentation about the QtC internals is thin. Far below the great Qt docs. With the SO docs there is at least a chance, that volunteers can jump on and add to my docs, or even edit them when I make a mistake.

And 'kept close to and maintained'...Did not really happen, else I wouldn't have had so much work to get into the code. Please, don't take this as criticism. A Qt like documentation for QtC would be overkill. Qt and QtC have different requirements. But this means that it might be necessary to try several methods of documentation and see which works best. SO could be one of those methods.

Guido



Guido
_______________________________________________
Qt-creator mailing list
Qt-creator at qt-project.org<mailto:Qt-creator at qt-project.org>
http://lists.qt-project.org/mailman/listinfo/qt-creator

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.qt-project.org/pipermail/qt-creator/attachments/20130906/d3a62d87/attachment.html>