[Interest] making qt examples more verbal
sivan at omniqueue.com
Thu Nov 10 13:56:42 CET 2011
I would like to propose a first step improvement to Qt's Examples. My
target goal as I see it would be to augment all the qt examples we
have with enough commentary such that they could be used as recipes.
This means , as per Qt example writing guidelines  to walk through
all of the code in the examples, excluding ofcourse the really trivial
things and concentrating on the parts of code more relevant to what
the example demonstrates.
The first task I figured would be quick and easier to pursue, would
be to add commentary and pointers as per the subject the example is to
For example, let us take the weather example  that I arrived at
through this URL traversal:
>From that , as I'm looking to know how to retrieve location I went to:
(q: why not link straight to the example?)
and from that , to:
Now, since I am developing a location based app, perhaps it would be
safe to say the thing I am most interested in would be the gory
details of how to achieve the current location or some suggestive
It would be nice to have, before the file list as per Qt example
format, a quick linkfied jump to the code that does that with enough
walk through to enable a user as quickly as possible to apply the code
to his needs. In this particular example I assume that would be the
snippet that deals with signals and slots for positionUpdated().
Having those would already make the examples good as recipes, later on
adding full commentary for the important code snippets from an
example, would enable more granular searching for terms and code
snippets through the Qt Creator example browser.
Does this make sense? Is it worth a bug report to track working on it?
More information about the Interest