Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(30)

Side by Side Diff: util/stdlib/pointer_container.h

Issue 688643002: Fix a few documentation problems (Closed) Base URL: https://chromium.googlesource.com/crashpad/crashpad@master
Patch Set: Created 6 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « snapshot/test/test_module_snapshot.h ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 // Copyright 2014 The Crashpad Authors. All rights reserved. 1 // Copyright 2014 The Crashpad Authors. All rights reserved.
2 // 2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); 3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License. 4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at 5 // You may obtain a copy of the License at
6 // 6 //
7 // http://www.apache.org/licenses/LICENSE-2.0 7 // http://www.apache.org/licenses/LICENSE-2.0
8 // 8 //
9 // Unless required by applicable law or agreed to in writing, software 9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, 10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and 12 // See the License for the specific language governing permissions and
13 // limitations under the License. 13 // limitations under the License.
14 14
15 #ifndef CRASHPAD_UTIL_STDLIB_POINTER_CONTAINER_H_ 15 #ifndef CRASHPAD_UTIL_STDLIB_POINTER_CONTAINER_H_
16 #define CRASHPAD_UTIL_STDLIB_POINTER_CONTAINER_H_ 16 #define CRASHPAD_UTIL_STDLIB_POINTER_CONTAINER_H_
17 17
18 #include <vector> 18 #include <vector>
19 19
20 #include "base/basictypes.h"
20 #include "base/stl_util.h" 21 #include "base/stl_util.h"
21 22
22 namespace crashpad { 23 namespace crashpad {
23 24
24 // PointerContainer allows an STL container such as std::vector<> to “own” 25 //! \brief Allows a standard container to “own” pointer elements stored in it.
25 // pointer elements stored in it. When the container is destroyed, “delete” will 26 //!
26 // be called on its pointer elements. 27 //! When the container is destroyed, `delete` will be called on its pointer
28 //! elements.
29 //!
30 //! \note No attempt is made to `delete` elements that are removed from the
31 //! container by other means, such as replacement or `clear()`.
27 template <typename ContainerType> 32 template <typename ContainerType>
28 class PointerContainer : public ContainerType { 33 class PointerContainer : public ContainerType {
29 public: 34 public:
30 PointerContainer() : ContainerType(), pointer_deleter_(this) {} 35 PointerContainer() : ContainerType(), pointer_deleter_(this) {}
31 36
32 ~PointerContainer() {} 37 ~PointerContainer() {}
33 38
34 private: 39 private:
35 STLElementDeleter<ContainerType> pointer_deleter_; 40 STLElementDeleter<ContainerType> pointer_deleter_;
41
42 DISALLOW_COPY_AND_ASSIGN(PointerContainer);
36 }; 43 };
37 44
45 //! \brief Allows a `std::vector` to “own” pointer elements stored in it.
46 //!
47 //! When the vector is destroyed, `delete` will be called on its pointer
48 //! elements.
49 //!
50 //! \note No attempt is made to `delete` elements that are removed from the
51 //! vector by other means, such as replacement or `clear()`.
38 template <typename T> 52 template <typename T>
39 class PointerVector : public PointerContainer<std::vector<T*> > {}; 53 class PointerVector : public PointerContainer<std::vector<T*>> {};
40 54
41 } // namespace crashpad 55 } // namespace crashpad
42 56
43 #endif // CRASHPAD_UTIL_STDLIB_POINTER_CONTAINER_H_ 57 #endif // CRASHPAD_UTIL_STDLIB_POINTER_CONTAINER_H_
OLDNEW
« no previous file with comments | « snapshot/test/test_module_snapshot.h ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698