Documentation bug - QMultiMap

Discuss anything related to product development
Post Reply
seasoned_geek
Posts: 128
Joined: Thu Jun 11 2020 12:18 pm

Documentation bug - QMultiMap

Post by seasoned_geek »

https://www.copperspice.com/docs/cs_api/class_qmultimap.html#ab46fccfa7919676fb902dfed2085858e

Introduces C compare which is not part of Qt. Uses it lots of places.

QMultiMap (C compare)

QMultiMap (const QMultiMap< Key, Val, C > &other) = default

QMultiMap (const std::multimap< Key, Val, C > &other)

Not one single example of it in the doc. The closest it comes to explaining it is this.

====
QMultiMap< Key, Val, C >::QMultiMap ( C compare )
inlineexplicit

Constructs an empty multimap using the passed comparison object.

====

barbara
Posts: 284
Joined: Sat Apr 04 2015 2:32 am

Re: Documentation bug - QMultiMap

Post by barbara »

seasoned_geek wrote:
Fri Sep 17 2021 9:18 pm
Introduces C compare which is not part of Qt. Uses it lots of places.
It is very important to understand that CopperSpice is not Qt. We are transitioning to a set of libraries and away from a framework. We kindly ask that you migrate away from thinking that CopperSpice needs to match what they have implemented. Our goal is to add what is needed by our user base.

The Compare template parameter is part of C++ and was added to CopperSpice for multiple reasons. If you are unfamiliar with this template parameter or would like to suggest we improve our documentation, awesome. This may be something you have not used or believe others would benefit from having a more detailed explanation. Again, great idea.

In fact, our API documentation just went through a major proof reading process and legacy spelling issues were fixed, tables were cleaned up, and several areas were updated. Please continue to read the docs and simply let us know what you need clarification.

Barbara

barbara
Posts: 284
Joined: Sat Apr 04 2015 2:32 am

Re: Documentation bug - QMultiMap

Post by barbara »

We did a review of QMap and QMultiMap and there is more information about the compare template parameter in the QMap documentation.

Please have a look in the detailed section for "Overriding Sort Order" (in QMap) where we show the default comparator and also an example of a user defined Compare class.

We are going to enhance this section in QMap and also add a notation in QMultiMap indicating that users should read the QMap detailed documentation.

barbara
Posts: 284
Joined: Sat Apr 04 2015 2:32 am

Re: Documentation bug - QMultiMap

Post by barbara »

New CopperSpice API documentation has been uploaded. There are a substantial changes in the parameter names and improved method descriptions. Both QMap and QMultiMap were changed.

Barbara

Post Reply