diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-20 19:37:07 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-04-19 07:34:53 +0200 |
commit | 0bc02fd0d61d1e4aed9b39890d28975dff30e822 (patch) | |
tree | e967ab719c7f8df24c35b088bd48e0f5b0942148 /src/corelib/tools/qmap.cpp | |
parent | 7f0c130be963de90d1baeb037820b17a4f298700 (diff) |
Doc: Prepare for building modular QtCore docs.
This change fixes most qdoc errors in QtCore. There are about 900 left.
The main thing this change does is moving documentation from qtcore from
/doc/src to /src/corelib/doc.
Other issues resolved are mis-use of qdoc commands.
Change-Id: I002d01edfb13575e8bf27ce91596a577a92562d1
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Reviewed-by: Jason McDonald <jason.mcdonald@nokia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'src/corelib/tools/qmap.cpp')
-rw-r--r-- | src/corelib/tools/qmap.cpp | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/src/corelib/tools/qmap.cpp b/src/corelib/tools/qmap.cpp index 90521d343c..8002e7c1f0 100644 --- a/src/corelib/tools/qmap.cpp +++ b/src/corelib/tools/qmap.cpp @@ -388,21 +388,21 @@ void QMapDataBase::freeData(QMapDataBase *d) \endlist Here's an example QMap with QString keys and \c int values: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 0 + \snippet code/src_corelib_tools_qmap.cpp 0 To insert a (key, value) pair into the map, you can use operator[](): - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 1 + \snippet code/src_corelib_tools_qmap.cpp 1 This inserts the following three (key, value) pairs into the QMap: ("one", 1), ("three", 3), and ("seven", 7). Another way to insert items into the map is to use insert(): - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 2 + \snippet code/src_corelib_tools_qmap.cpp 2 To look up a value, use operator[]() or value(): - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 3 + \snippet code/src_corelib_tools_qmap.cpp 3 If there is no item with the specified key in the map, these functions return a \l{default-constructed value}. @@ -410,12 +410,12 @@ void QMapDataBase::freeData(QMapDataBase *d) If you want to check whether the map contains a certain key, use contains(): - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 4 + \snippet code/src_corelib_tools_qmap.cpp 4 There is also a value() overload that uses its second argument as a default value if there is no item with the specified key: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 5 + \snippet code/src_corelib_tools_qmap.cpp 5 In general, we recommend that you use contains() and value() rather than operator[]() for looking up a key in a map. The @@ -424,7 +424,7 @@ void QMapDataBase::freeData(QMapDataBase *d) const). For example, the following code snippet will create 1000 items in memory: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 6 + \snippet code/src_corelib_tools_qmap.cpp 6 To avoid this problem, replace \c map[i] with \c map.value(i) in the code above. @@ -436,11 +436,11 @@ void QMapDataBase::freeData(QMapDataBase *d) QMap::iterator). Here's how to iterate over a QMap<QString, int> using a Java-style iterator: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 7 + \snippet code/src_corelib_tools_qmap.cpp 7 Here's the same code, but using an STL-style iterator this time: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 8 + \snippet code/src_corelib_tools_qmap.cpp 8 The items are traversed in ascending key order. @@ -448,7 +448,7 @@ void QMapDataBase::freeData(QMapDataBase *d) insert() with a key that already exists in the QMap, the previous value will be erased. For example: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 9 + \snippet code/src_corelib_tools_qmap.cpp 9 However, you can store multiple values per key by using insertMulti() instead of insert() (or using the convenience @@ -456,19 +456,19 @@ void QMapDataBase::freeData(QMapDataBase *d) single key, you can use values(const Key &key), which returns a QList<T>: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 10 + \snippet code/src_corelib_tools_qmap.cpp 10 The items that share the same key are available from most recently to least recently inserted. Another approach is to call find() to get the STL-style iterator for the first item with a key and iterate from there: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 11 + \snippet code/src_corelib_tools_qmap.cpp 11 If you only need to extract the values from a map (not the keys), you can also use \l{foreach}: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 12 + \snippet code/src_corelib_tools_qmap.cpp 12 Items can be removed from the map in several ways. One way is to call remove(); this will remove any item with the given key. @@ -484,7 +484,7 @@ void QMapDataBase::freeData(QMapDataBase *d) < y} nor \c{y < x} is true. Example: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 13 + \snippet code/src_corelib_tools_qmap.cpp 13 In the example, we start by comparing the employees' names. If they're equal, we compare their dates of birth to break the tie. @@ -881,7 +881,7 @@ void QMapDataBase::freeData(QMapDataBase *d) the iterator. For example, here's some code that iterates over all the items with the same key: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 14 + \snippet code/src_corelib_tools_qmap.cpp 14 \sa constFind(), value(), values(), lowerBound(), upperBound(), QMultiMap::find() */ @@ -911,7 +911,7 @@ void QMapDataBase::freeData(QMapDataBase *d) key. Example: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 15 + \snippet code/src_corelib_tools_qmap.cpp 15 If the map contains multiple items with key \a key, this function returns an iterator that points to the most recently @@ -919,7 +919,7 @@ void QMapDataBase::freeData(QMapDataBase *d) the iterator. For example, here's some code that iterates over all the items with the same key: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 16 + \snippet code/src_corelib_tools_qmap.cpp 16 \sa qLowerBound(), upperBound(), find() */ @@ -937,7 +937,7 @@ void QMapDataBase::freeData(QMapDataBase *d) nearest item with a greater key. Example: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 17 + \snippet code/src_corelib_tools_qmap.cpp 17 \sa qUpperBound(), lowerBound(), find() */ @@ -1042,7 +1042,7 @@ void QMapDataBase::freeData(QMapDataBase *d) start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 18 + \snippet code/src_corelib_tools_qmap.cpp 18 Unlike QHash, which stores its items in an arbitrary order, QMap stores its items ordered by key. Items that share the same key @@ -1055,22 +1055,22 @@ void QMapDataBase::freeData(QMapDataBase *d) Here's an example that increments every value stored in the QMap by 2: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 19 + \snippet code/src_corelib_tools_qmap.cpp 19 Here's an example that removes all the items whose key is a string that starts with an underscore character: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 20 + \snippet code/src_corelib_tools_qmap.cpp 20 The call to QMap::erase() removes the item pointed to by the iterator from the map, and returns an iterator to the next item. Here's another way of removing an item while iterating: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 21 + \snippet code/src_corelib_tools_qmap.cpp 21 It might be tempting to write code like this: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 22 + \snippet code/src_corelib_tools_qmap.cpp 22 However, this will potentially crash in \c{++i}, because \c i is a dangling iterator after the call to erase(). @@ -1122,7 +1122,7 @@ void QMapDataBase::freeData(QMapDataBase *d) called on an uninitialized iterator. Use operator=() to assign a value to it before using it. - \sa QMap::begin() QMap::end() + \sa QMap::begin(), QMap::end() */ /*! \fn QMap::iterator::iterator(QMapData::Node *node) @@ -1148,7 +1148,7 @@ void QMapDataBase::freeData(QMapDataBase *d) You can change the value of an item by using value() on the left side of an assignment, for example: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 23 + \snippet code/src_corelib_tools_qmap.cpp 23 \sa key(), operator*() */ @@ -1289,7 +1289,7 @@ void QMapDataBase::freeData(QMapDataBase *d) QMap::find() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 24 + \snippet code/src_corelib_tools_qmap.cpp 24 Unlike QHash, which stores its items in an arbitrary order, QMap stores its items ordered by key. Items that share the same key @@ -1344,7 +1344,7 @@ void QMapDataBase::freeData(QMapDataBase *d) called on an uninitialized iterator. Use operator=() to assign a value to it before using it. - \sa QMap::constBegin() QMap::constEnd() + \sa QMap::constBegin(), QMap::constEnd() */ /*! \fn QMap::const_iterator::const_iterator(QMapData::Node *node) @@ -1530,7 +1530,7 @@ void QMapDataBase::freeData(QMapDataBase *d) operator+=(). Example: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 25 + \snippet code/src_corelib_tools_qmap.cpp 25 Unlike QMap, QMultiMap provides no operator[]. Use value() or replace() if you want to access the most recently inserted item @@ -1539,7 +1539,7 @@ void QMapDataBase::freeData(QMapDataBase *d) If you want to retrieve all the values for a single key, you can use values(const Key &key), which returns a QList<T>: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 26 + \snippet code/src_corelib_tools_qmap.cpp 26 The items that share the same key are available from most recently to least recently inserted. @@ -1548,7 +1548,7 @@ void QMapDataBase::freeData(QMapDataBase *d) the iterator for the first item with a key and iterate from there: - \snippet doc/src/snippets/code/src_corelib_tools_qmap.cpp 27 + \snippet code/src_corelib_tools_qmap.cpp 27 QMultiMap's key and value data types must be \l{assignable data types}. This covers most data types you are likely to encounter, |