Where I could get more details and examples about API functions?
-
Hi,Qt experts.
I find that just few API functions have examples and run effect in Qt Assistant.
For example,
[
QDir::exists();
with the same name of what? of directory or QString path like "example"?
And
QSettings::contains(const QString &key);
If I set group using beginGruop(),what I supposed to fill in 'key'?
Not need to answer above questions,I had googled them.
]
So how could I get documents with more details,examples and run effect about those API functions? Or I use Qt Assistant in a wrong way?
Thanks for your reply.
Regards,
Qtcpp_User -
Hi,Qt experts.
I find that just few API functions have examples and run effect in Qt Assistant.
For example,
[
QDir::exists();
with the same name of what? of directory or QString path like "example"?
And
QSettings::contains(const QString &key);
If I set group using beginGruop(),what I supposed to fill in 'key'?
Not need to answer above questions,I had googled them.
]
So how could I get documents with more details,examples and run effect about those API functions? Or I use Qt Assistant in a wrong way?
Thanks for your reply.
Regards,
Qtcpp_User@Qtcpp_User To me these texts are clear.
But if you have a suggestion how to improve the documentation, please either report it on Qt bugtracker or consider preparing some patches and contributing them.
-
Hi,Qt experts.
I find that just few API functions have examples and run effect in Qt Assistant.
For example,
[
QDir::exists();
with the same name of what? of directory or QString path like "example"?
And
QSettings::contains(const QString &key);
If I set group using beginGruop(),what I supposed to fill in 'key'?
Not need to answer above questions,I had googled them.
]
So how could I get documents with more details,examples and run effect about those API functions? Or I use Qt Assistant in a wrong way?
Thanks for your reply.
Regards,
Qtcpp_User@Qtcpp_User said in Where I could get more details and examples about API functions?:
Not need to answer above questions,I had googled them.
And I would use Google if you seek more clarity on the API functions! You canot expect documentation to provide an example of anything you might want to know.....
-
@Qtcpp_User To me these texts are clear.
But if you have a suggestion how to improve the documentation, please either report it on Qt bugtracker or consider preparing some patches and contributing them.
@sierdzio
Good days,
It just few simple API. but when use complicated API with multiple parameters which are described briefly, I have to try one by one to see run effects. It not nice to new users especially.
Qt bugtracker ? It not a bug , right? And I saw some particular posts or blogs, it not appear in Qt Assistant. So I guess there is no way to report this or maybe not in Qt bugtracker?
And I think the best way to solve it is refer to "Baidu Baike" or "Wikipedia". Let users edit Assistant documentation to detail API those they are familiar. The Qt Assistant is independent of Qt Creator. So it maybe not influence Creator, even if Assistant broken. What do you think about it? You are moderators, maybe Qt would consider your suggestion.
Thanks for your reply. -
@Qtcpp_User said in Where I could get more details and examples about API functions?:
Not need to answer above questions,I had googled them.
And I would use Google if you seek more clarity on the API functions! You canot expect documentation to provide an example of anything you might want to know.....
@JonB
Good days,
Yeah, I used to use Google to seek information when programming. Until I spent minutes or hours to find it is abandoned API or outdated information in posts or blogs searched by Google several times. I started to read official documentation. But it not my expected.
I thought I used Assistant in a wrong way. But now it seem I have to combine them.
Or do you have some suggestions or somethings for me.
Thanks for your reply. -
Q Qtcpp_User has marked this topic as solved on
-
Hi,Qt experts.
I find that just few API functions have examples and run effect in Qt Assistant.
For example,
[
QDir::exists();
with the same name of what? of directory or QString path like "example"?
And
QSettings::contains(const QString &key);
If I set group using beginGruop(),what I supposed to fill in 'key'?
Not need to answer above questions,I had googled them.
]
So how could I get documents with more details,examples and run effect about those API functions? Or I use Qt Assistant in a wrong way?
Thanks for your reply.
Regards,
Qtcpp_User@Qtcpp_User said in Where I could get more details and examples about API functions?:
with the same name of what? of directory or QString path like "example"?
With the same name of
QDir?! What else?!
Btw:exampleis the name of the "to-be-tested" directory. It can be a full path, it can be just a directory name relative to the current directory.If I set group using beginGruop(),what I supposed to fill in 'key'?
The
keyyou want to check, maybe?!Asking those questions is the same as asking, what the ampersand in
const QString &keydoes and why it's there...
Even when there is a documentation, it's expected to have a certain level of knowledge and maybe some experience from using other frameworks / libraries.
Also the context where it's used is important and might help to understand what the text means.
