Documentation - QNetworkAccessManager

Report any problems with CopperSpice
Post Reply
seasoned_geek
Posts: 254
Joined: Thu Jun 11 2020 12:18 pm

Documentation - QNetworkAccessManager

Post by seasoned_geek »

All,

Could we please have the on-line documentation for each class list the appropriate header file?

https://www.copperspice.com/docs/cs_api/class_qnetworkaccessmanager.html#details

#include <QtNetwork/QNetAccess_Manager> is what one needs. That's not obvious from the class name or documentation.
barbara
Posts: 452
Joined: Sat Apr 04 2015 2:32 am
Contact:

Re: Documentation - QNetworkAccessManager

Post by barbara »

The changes to the CsNetwork header files was available in the CS Overview migration documentation. We understand users may not have known about this information.

I just made a change to the API documentation which explains these file name changes. Everything is located on one page since this has occurred for a few libraries. From the main index page we added a new listing for "Header Files". It will link to the following page:

https://www.copperspice.com/docs/cs_api/concepts-headers.html

#include <QtNetwork/QNetAccess_Manager>
This is an older style for specifying includes. You simply need to provide the name #include <QNetAccess_Manager>. The library prefix is no longer recommended.

Barbara
seasoned_geek
Posts: 254
Joined: Thu Jun 11 2020 12:18 pm

Re: Documentation - QNetworkAccessManager

Post by seasoned_geek »

I understand wanting to have a single page with the header files, that simply isn't going to fit the use case for 99.999% of all developers looking at the documentation on-line.

Here's how it normally goes:
  • copperspice.com
  • click Documentation
  • click Copperspice
  • click Copperspice API
  • Enter partial class name in search bar
  • View documentation for class
The include file for every class needs to be documented at this landing page.

Prior to the rename where 100% of the time the include file matched the last name, this wasn't an issue. It's an issue now. Even if you don't want to do it, the alternative will be that landing page for each class will need:

To find out what header file you need to use for this class click this link.
Post Reply