Page 1 of 1

QApplication documentation bug

Posted: Fri Jan 22 2021 10:30 am
by seasoned_geek
When you visit here

https://www.copperspice.com/docs/cs_api/class_qapplication.html#a6a268e144ee8ee77882a3c9a010a661e

You see this line.

Code: Select all

int  	flags = ApplicationFlags 
This is a break from the Qt 4.8 documentation.

There is no link in the CopperSpice definition of that constructor nor is there any definition provided as to the expected content and use of "flags". Type type, Qt::HANDLE visural = 0, Qt::HANDLE colormap = 0, Display *display, but one cannot be sure.

Also really missing this feature of Qt documentation.

> List of all members, including inherited members

That feature is sooooo nice.

Re: QApplication documentation bug

Posted: Fri Jan 22 2021 10:36 am
by seasoned_geek
My bad, you hid the "list all" way up over here in the corner.

Re: QApplication documentation bug

Posted: Fri Jan 22 2021 9:52 pm
by barbara
seasoned_geek wrote:
Fri Jan 22 2021 10:30 am
This is a break from the Qt 4.8 documentation.

There is no link in the CopperSpice definition of that constructor nor is there any definition provided as to the expected content and use of "flags". Type type, Qt::HANDLE visural = 0, Qt::HANDLE colormap = 0, Display *display, but one cannot be sure.
The CopperSpice documentation is not suppose to be documentary for another product. We very much appreciate feedback saying, I could not find something or this was unclear. Please recognize that our layout is different and and many things have moved. This is based on user feedback. We are are asking you to refrain from saying, but this works differently and you need to change it back.

The text in the documentation has been updated to reflect how CopperSpice works. We have also changed wording to use proper English and improved examples. This is an on going process and will take time to perfect. The CopperSpice project will get there with the help of the team and our users.

Now, lets talk about what you think is missing in our CS API docs. We looked at the constructor you mentioned and could not figure out the issue you are having. Please simply state the problem and we can banter with you.
Also really missing this feature of Qt documentation.

> List of all members, including inherited members
Under the Search box in the upper right corner is a set of links. This list of links will change depending on the class. Typicall you will see things like the following.

Public Typedefs | Public Signals | Public Slots | Public Methods | Static Public Methods | Protected Methods | Properties |

Re: QApplication documentation bug

Posted: Sat Jan 23 2021 4:57 pm
by seasoned_geek
I can't make it any clearer without providing screenshots. I doubt those would have helped here because the response went down a rabbit hole.

Please follow the link:

https://www.copperspice.com/docs/cs_api/class_qapplication.html#a6a268e144ee8ee77882a3c9a010a661e

You clearly see this line in the constructor.

int flags = ApplicationFlags

There is no definition anywhere in the doc for ApplicationFlags.

You have an undocumented parameter in the constructor.

Re: QApplication documentation bug

Posted: Sun Jan 24 2021 3:49 am
by barbara
seasoned_geek wrote:
Sat Jan 23 2021 4:57 pm
int flags = ApplicationFlags

There is no definition anywhere in the doc for ApplicationFlags.
This is all we needed, just let us know what you found unclear or missing. I would ask we refrain from complaining, and lets's stay focused on what you think needs correcting.

We are happy to investigate and figure this out.

Re: QApplication documentation bug

Posted: Tue Jan 26 2021 8:13 pm
by barbara
We received a comment about the status of our CS API documentation. As will all written docs, they evolve and will continue to do so indefinitely.

As users of C++ we use CppReference for information about the core language and standard library. As users of CopperSpice use our API documentation for information about our libraries.

If you have questions or comments please submit them in a professional manner.

CopperSpice Team