Ticket #6205: container_docs.txt

File container_docs.txt, 21.3 KB (added by jwakely.boost@…, 11 years ago)

patch to fix documentation comments

Line 
1Index: boost/container/list.hpp
2===================================================================
3--- boost/container/list.hpp (revision 75790)
4+++ boost/container/list.hpp (working copy)
5@@ -692,7 +692,7 @@ class list
6 }
7
8 //! <b>Effects</b>: Swaps the contents of *this and x.
9- //! If this->allocator_type() != x.allocator_type()
10+ //! If this->get_allocator() != x.get_allocator()
11 //! allocators are also swapped.
12 //!
13 //! <b>Throws</b>: Nothing.
14Index: boost/container/set.hpp
15===================================================================
16--- boost/container/set.hpp (revision 75790)
17+++ boost/container/set.hpp (working copy)
18@@ -310,7 +310,7 @@ class set
19 { return m_tree.max_size(); }
20
21 //! <b>Effects</b>: Swaps the contents of *this and x.
22- //! If this->allocator_type() != x.allocator_type() allocators are also swapped.
23+ //! If this->get_allocator() != x.get_allocator() allocators are also swapped.
24 //!
25 //! <b>Throws</b>: Nothing.
26 //!
27@@ -873,7 +873,7 @@ class multiset
28 { return m_tree.max_size(); }
29
30 //! <b>Effects</b>: Swaps the contents of *this and x.
31- //! If this->allocator_type() != x.allocator_type() allocators are also swapped.
32+ //! If this->get_allocator() != x.get_allocator() allocators are also swapped.
33 //!
34 //! <b>Throws</b>: Nothing.
35 //!
36Index: boost/container/stable_vector.hpp
37===================================================================
38--- boost/container/stable_vector.hpp (revision 75790)
39+++ boost/container/stable_vector.hpp (working copy)
40@@ -1148,7 +1148,7 @@ class stable_vector
41 { return priv_erase(first, last, alloc_version()); }
42
43 //! <b>Effects</b>: Swaps the contents of *this and x.
44- //! If this->allocator_type() != x.allocator_type()
45+ //! If this->get_allocator() != x.get_allocator()
46 //! allocators are also swapped.
47 //!
48 //! <b>Throws</b>: Nothing.
49Index: boost/container/map.hpp
50===================================================================
51--- boost/container/map.hpp (revision 75790)
52+++ boost/container/map.hpp (working copy)
53@@ -381,7 +381,7 @@ class map
54 }
55
56 //! <b>Effects</b>: Swaps the contents of *this and x.
57- //! If this->allocator_type() != x.allocator_type() allocators are also swapped.
58+ //! If this->get_allocator() != x.get_allocator() allocators are also swapped.
59 //!
60 //! <b>Throws</b>: Nothing.
61 //!
62@@ -989,7 +989,7 @@ class multimap
63 { return m_tree.max_size(); }
64
65 //! <b>Effects</b>: Swaps the contents of *this and x.
66- //! If this->allocator_type() != x.allocator_type() allocators are also swapped.
67+ //! If this->get_allocator() != x.get_allocator() allocators are also swapped.
68 //!
69 //! <b>Throws</b>: Nothing.
70 //!
71Index: boost/container/slist.hpp
72===================================================================
73--- boost/container/slist.hpp (revision 75790)
74+++ boost/container/slist.hpp (working copy)
75@@ -563,7 +563,7 @@ class slist
76 { return !this->size(); }
77
78 //! <b>Effects</b>: Swaps the contents of *this and x.
79- //! If this->allocator_type() != x.allocator_type()
80+ //! If this->get_allocator() != x.get_allocator()
81 //! allocators are also swapped.
82 //!
83 //! <b>Throws</b>: Nothing.
84Index: boost/container/flat_set.hpp
85===================================================================
86--- boost/container/flat_set.hpp (revision 75790)
87+++ boost/container/flat_set.hpp (working copy)
88@@ -317,7 +317,7 @@ class flat_set
89 { return m_flat_tree.max_size(); }
90
91 //! <b>Effects</b>: Swaps the contents of *this and x.
92- //! If this->allocator_type() != x.allocator_type() allocators are also swapped.
93+ //! If this->get_allocator() != x.get_allocator() allocators are also swapped.
94 //!
95 //! <b>Throws</b>: Nothing.
96 //!
97@@ -335,7 +335,7 @@ class flat_set
98 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
99 //! to the elements with bigger keys than x.
100 //!
101- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
102+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
103 std::pair<iterator, bool> insert(insert_const_ref_type x)
104 { return priv_insert(x); }
105
106@@ -358,7 +358,7 @@ class flat_set
107 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
108 //! to the elements with bigger keys than x.
109 //!
110- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
111+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
112 std::pair<iterator,bool> insert(BOOST_RV_REF(value_type) x)
113 { return m_flat_tree.insert_unique(boost::move(x)); }
114
115@@ -372,7 +372,7 @@ class flat_set
116 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
117 //! right before p) plus insertion linear to the elements with bigger keys than x.
118 //!
119- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
120+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
121 iterator insert(const_iterator p, insert_const_ref_type x)
122 { return priv_insert(p, x); }
123
124@@ -393,7 +393,7 @@ class flat_set
125 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
126 //! right before p) plus insertion linear to the elements with bigger keys than x.
127 //!
128- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
129+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
130 iterator insert(const_iterator position, BOOST_RV_REF(value_type) x)
131 { return m_flat_tree.insert_unique(position, boost::move(x)); }
132
133@@ -405,7 +405,7 @@ class flat_set
134 //! <b>Complexity</b>: At most N log(size()+N) (N is the distance from first to last)
135 //! search time plus N*size() insertion time.
136 //!
137- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
138+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
139 template <class InputIterator>
140 void insert(InputIterator first, InputIterator last)
141 { m_flat_tree.insert_unique(first, last); }
142@@ -423,7 +423,7 @@ class flat_set
143 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
144 //! to the elements with bigger keys than x.
145 //!
146- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
147+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
148 template <class... Args>
149 iterator emplace(Args&&... args)
150 { return m_flat_tree.emplace_unique(boost::forward<Args>(args)...); }
151@@ -439,7 +439,7 @@ class flat_set
152 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
153 //! right before p) plus insertion linear to the elements with bigger keys than x.
154 //!
155- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
156+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
157 template <class... Args>
158 iterator emplace_hint(const_iterator hint, Args&&... args)
159 { return m_flat_tree.emplace_hint_unique(hint, boost::forward<Args>(args)...); }
160@@ -920,7 +920,7 @@ class flat_multiset
161 { return m_flat_tree.max_size(); }
162
163 //! <b>Effects</b>: Swaps the contents of *this and x.
164- //! If this->allocator_type() != x.allocator_type() allocators are also swapped.
165+ //! If this->get_allocator() != x.get_allocator() allocators are also swapped.
166 //!
167 //! <b>Throws</b>: Nothing.
168 //!
169@@ -934,7 +934,7 @@ class flat_multiset
170 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
171 //! to the elements with bigger keys than x.
172 //!
173- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
174+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
175 iterator insert(insert_const_ref_type x)
176 { return priv_insert(x); }
177
178@@ -953,7 +953,7 @@ class flat_multiset
179 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
180 //! to the elements with bigger keys than x.
181 //!
182- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
183+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
184 iterator insert(BOOST_RV_REF(value_type) x)
185 { return m_flat_tree.insert_equal(boost::move(x)); }
186
187@@ -966,7 +966,7 @@ class flat_multiset
188 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
189 //! right before p) plus insertion linear to the elements with bigger keys than x.
190 //!
191- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
192+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
193 iterator insert(const_iterator p, insert_const_ref_type x)
194 { return priv_insert(p, x); }
195
196@@ -988,7 +988,7 @@ class flat_multiset
197 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
198 //! right before p) plus insertion linear to the elements with bigger keys than x.
199 //!
200- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
201+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
202 iterator insert(const_iterator position, BOOST_RV_REF(value_type) x)
203 { return m_flat_tree.insert_equal(position, boost::move(x)); }
204
205@@ -999,7 +999,7 @@ class flat_multiset
206 //! <b>Complexity</b>: At most N log(size()+N) (N is the distance from first to last)
207 //! search time plus N*size() insertion time.
208 //!
209- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
210+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
211 template <class InputIterator>
212 void insert(InputIterator first, InputIterator last)
213 { m_flat_tree.insert_equal(first, last); }
214@@ -1013,7 +1013,7 @@ class flat_multiset
215 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
216 //! to the elements with bigger keys than x.
217 //!
218- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
219+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
220 template <class... Args>
221 iterator emplace(Args&&... args)
222 { return m_flat_tree.emplace_equal(boost::forward<Args>(args)...); }
223@@ -1028,7 +1028,7 @@ class flat_multiset
224 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
225 //! right before p) plus insertion linear to the elements with bigger keys than x.
226 //!
227- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
228+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
229 template <class... Args>
230 iterator emplace_hint(const_iterator hint, Args&&... args)
231 { return m_flat_tree.emplace_hint_equal(hint, boost::forward<Args>(args)...); }
232Index: boost/container/vector.hpp
233===================================================================
234--- boost/container/vector.hpp (revision 75790)
235+++ boost/container/vector.hpp (working copy)
236@@ -1053,7 +1053,7 @@ class vector : private containers_detail
237 #endif //#ifdef BOOST_CONTAINERS_PERFECT_FORWARDING
238
239 //! <b>Effects</b>: Swaps the contents of *this and x.
240- //! If this->allocator_type() != x.allocator_type()
241+ //! If this->get_allocator() != x.get_allocator()
242 //! allocators are also swapped.
243 //!
244 //! <b>Throws</b>: Nothing.
245Index: boost/container/deque.hpp
246===================================================================
247--- boost/container/deque.hpp (revision 75790)
248+++ boost/container/deque.hpp (working copy)
249@@ -892,7 +892,7 @@ class deque : protected deque_base<T, A>
250 }
251
252 //! <b>Effects</b>: Swaps the contents of *this and x.
253- //! If this->allocator_type() != x.allocator_type()
254+ //! If this->get_allocator() != x.get_allocator()
255 //! allocators are also swapped.
256 //!
257 //! <b>Throws</b>: Nothing.
258Index: boost/container/flat_map.hpp
259===================================================================
260--- boost/container/flat_map.hpp (revision 75790)
261+++ boost/container/flat_map.hpp (working copy)
262@@ -428,7 +428,7 @@ class flat_map
263 }
264
265 //! <b>Effects</b>: Swaps the contents of *this and x.
266- //! If this->allocator_type() != x.allocator_type() allocators are also swapped.
267+ //! If this->get_allocator() != x.get_allocator() allocators are also swapped.
268 //!
269 //! <b>Throws</b>: Nothing.
270 //!
271@@ -446,7 +446,7 @@ class flat_map
272 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
273 //! to the elements with bigger keys than x.
274 //!
275- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
276+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
277 std::pair<iterator,bool> insert(const value_type& x)
278 { return force<std::pair<iterator,bool> >(
279 m_flat_tree.insert_unique(force<impl_value_type>(x))); }
280@@ -461,7 +461,7 @@ class flat_map
281 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
282 //! to the elements with bigger keys than x.
283 //!
284- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
285+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
286 std::pair<iterator,bool> insert(BOOST_RV_REF(value_type) x)
287 { return force<std::pair<iterator,bool> >(
288 m_flat_tree.insert_unique(boost::move(force<impl_value_type>(x)))); }
289@@ -476,7 +476,7 @@ class flat_map
290 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
291 //! to the elements with bigger keys than x.
292 //!
293- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
294+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
295 std::pair<iterator,bool> insert(BOOST_RV_REF(impl_value_type) x)
296 {
297 return force<std::pair<iterator,bool> >
298@@ -493,7 +493,7 @@ class flat_map
299 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
300 //! right before p) plus insertion linear to the elements with bigger keys than x.
301 //!
302- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
303+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
304 iterator insert(const_iterator position, const value_type& x)
305 { return force_copy<iterator>(
306 m_flat_tree.insert_unique(force<impl_const_iterator>(position), force<impl_value_type>(x))); }
307@@ -506,7 +506,7 @@ class flat_map
308 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
309 //! right before p) plus insertion linear to the elements with bigger keys than x.
310 //!
311- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
312+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
313 iterator insert(const_iterator position, BOOST_RV_REF(value_type) x)
314 { return force_copy<iterator>(
315 m_flat_tree.insert_unique(force<impl_const_iterator>(position), boost::move(force<impl_value_type>(x)))); }
316@@ -519,7 +519,7 @@ class flat_map
317 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
318 //! right before p) plus insertion linear to the elements with bigger keys than x.
319 //!
320- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
321+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
322 iterator insert(const_iterator position, BOOST_RV_REF(impl_value_type) x)
323 {
324 return force_copy<iterator>(
325@@ -534,7 +534,7 @@ class flat_map
326 //! <b>Complexity</b>: At most N log(size()+N) (N is the distance from first to last)
327 //! search time plus N*size() insertion time.
328 //!
329- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
330+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
331 template <class InputIterator>
332 void insert(InputIterator first, InputIterator last)
333 { m_flat_tree.insert_unique(first, last); }
334@@ -552,7 +552,7 @@ class flat_map
335 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
336 //! to the elements with bigger keys than x.
337 //!
338- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
339+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
340 template <class... Args>
341 iterator emplace(Args&&... args)
342 { return force_copy<iterator>(m_flat_tree.emplace_unique(boost::forward<Args>(args)...)); }
343@@ -568,7 +568,7 @@ class flat_map
344 //! <b>Complexity</b>: Logarithmic search time (constant if x is inserted
345 //! right before p) plus insertion linear to the elements with bigger keys than x.
346 //!
347- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
348+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
349 template <class... Args>
350 iterator emplace_hint(const_iterator hint, Args&&... args)
351 { return force_copy<iterator>(m_flat_tree.emplace_hint_unique(force<impl_const_iterator>(hint), boost::forward<Args>(args)...)); }
352@@ -1082,7 +1082,7 @@ class flat_multimap
353 { return m_flat_tree.max_size(); }
354
355 //! <b>Effects</b>: Swaps the contents of *this and x.
356- //! If this->allocator_type() != x.allocator_type() allocators are also swapped.
357+ //! If this->get_allocator() != x.get_allocator() allocators are also swapped.
358 //!
359 //! <b>Throws</b>: Nothing.
360 //!
361@@ -1096,7 +1096,7 @@ class flat_multimap
362 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
363 //! to the elements with bigger keys than x.
364 //!
365- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
366+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
367 iterator insert(const value_type& x)
368 { return force_copy<iterator>(m_flat_tree.insert_equal(force<impl_value_type>(x))); }
369
370@@ -1106,7 +1106,7 @@ class flat_multimap
371 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
372 //! to the elements with bigger keys than x.
373 //!
374- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
375+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
376 iterator insert(BOOST_RV_REF(value_type) x)
377 { return force_copy<iterator>(m_flat_tree.insert_equal(boost::move(x))); }
378
379@@ -1116,7 +1116,7 @@ class flat_multimap
380 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
381 //! to the elements with bigger keys than x.
382 //!
383- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
384+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
385 iterator insert(BOOST_RV_REF(impl_value_type) x)
386 { return force_copy<iterator>(m_flat_tree.insert_equal(boost::move(x))); }
387
388@@ -1130,7 +1130,7 @@ class flat_multimap
389 //! is to be inserted before p) plus linear insertion
390 //! to the elements with bigger keys than x.
391 //!
392- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
393+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
394 iterator insert(const_iterator position, const value_type& x)
395 { return force_copy<iterator>(m_flat_tree.insert_equal(force<impl_const_iterator>(position), force<impl_value_type>(x))); }
396
397@@ -1144,7 +1144,7 @@ class flat_multimap
398 //! is to be inserted before p) plus linear insertion
399 //! to the elements with bigger keys than x.
400 //!
401- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
402+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
403 iterator insert(const_iterator position, BOOST_RV_REF(value_type) x)
404 {
405 return force_copy<iterator>
406@@ -1162,7 +1162,7 @@ class flat_multimap
407 //! is to be inserted before p) plus linear insertion
408 //! to the elements with bigger keys than x.
409 //!
410- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
411+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
412 iterator insert(const_iterator position, BOOST_RV_REF(impl_value_type) x)
413 {
414 return force_copy<iterator>(
415@@ -1176,7 +1176,7 @@ class flat_multimap
416 //! <b>Complexity</b>: At most N log(size()+N) (N is the distance from first to last)
417 //! search time plus N*size() insertion time.
418 //!
419- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
420+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
421 template <class InputIterator>
422 void insert(InputIterator first, InputIterator last)
423 { m_flat_tree.insert_equal(first, last); }
424@@ -1190,7 +1190,7 @@ class flat_multimap
425 //! <b>Complexity</b>: Logarithmic search time plus linear insertion
426 //! to the elements with bigger keys than x.
427 //!
428- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
429+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
430 template <class... Args>
431 iterator emplace(Args&&... args)
432 { return force_copy<iterator>(m_flat_tree.emplace_equal(boost::forward<Args>(args)...)); }
433@@ -1206,7 +1206,7 @@ class flat_multimap
434 //! is to be inserted before p) plus linear insertion
435 //! to the elements with bigger keys than x.
436 //!
437- //! <b>Note</b>: If an element it's inserted it might invalidate elements.
438+ //! <b>Note</b>: If an element is inserted it might invalidate elements.
439 template <class... Args>
440 iterator emplace_hint(const_iterator hint, Args&&... args)
441 {