Fix a few documentation problems.

R=rsesek@chromium.org

Review URL: https://codereview.chromium.org/688643002
This commit is contained in:
Mark Mentovai 2014-10-29 11:33:34 -04:00
parent 78bec65b27
commit 7f30a9ebef
4 changed files with 25 additions and 11 deletions

View File

@ -30,7 +30,7 @@ static const uint32_t kCrashpadInfoVersion = 1;
namespace crashpad {
#if CXX_LIBRARY_VERSION >= 2011
#if CXX_LIBRARY_VERSION >= 2011 || DOXYGEN
// In C++11, check that CrashpadInfo has standard layout, which is what is
// actually important.
static_assert(std::is_standard_layout<CrashpadInfo>::value,

View File

@ -164,8 +164,8 @@ enum MINIDUMP_STREAM_TYPE {
//!
//! The exact version of the stream that is present is implied by the streams
//! size. Furthermore, this stream contains a field,
//! MINIDUMP_MISC_INFO_STREAM::Flags1, that indicates which data is present
//! and valid.
//! MINIDUMP_MISC_INFO::Flags1, that indicates which data is present and
//! valid.
MiscInfoStream = 15,
};
@ -840,9 +840,9 @@ enum MINIDUMP_TYPE {
//! - A MINIDUMP_MODULE_LIST stream. All loaded modules are present.
//! - Typically, a MINIDUMP_MEMORY_LIST stream containing duplicate pointers
//! to the stack memory regions also referenced by the MINIDUMP_THREAD_LIST
//! stream. Since Windows 7 (NT 6.1), this type of minidump file also
//! includes a MINIDUMP_MEMORY_DESCRIPTOR containing the 256 bytes centered
//! around the exception address or the instruction pointer.
//! stream. This type of minidump file also includes a
//! MINIDUMP_MEMORY_DESCRIPTOR containing the 256 bytes centered around
//! the exception address or the instruction pointer.
MiniDumpNormal = 0x00000000,
};

View File

@ -28,7 +28,7 @@
namespace crashpad {
namespace test {
//! \brief A test ModuleSnapshot that can carries arbitrary data for testing
//! \brief A test ModuleSnapshot that can carry arbitrary data for testing
//! purposes.
class TestModuleSnapshot final : public ModuleSnapshot {
public:

View File

@ -17,13 +17,18 @@
#include <vector>
#include "base/basictypes.h"
#include "base/stl_util.h"
namespace crashpad {
// PointerContainer allows an STL container such as std::vector<> to “own”
// pointer elements stored in it. When the container is destroyed, “delete” will
// be called on its pointer elements.
//! \brief Allows a standard container to “own” pointer elements stored in it.
//!
//! When the container is destroyed, `delete` will be called on its pointer
//! elements.
//!
//! \note No attempt is made to `delete` elements that are removed from the
//! container by other means, such as replacement or `clear()`.
template <typename ContainerType>
class PointerContainer : public ContainerType {
public:
@ -33,10 +38,19 @@ class PointerContainer : public ContainerType {
private:
STLElementDeleter<ContainerType> pointer_deleter_;
DISALLOW_COPY_AND_ASSIGN(PointerContainer);
};
//! \brief Allows a `std::vector` to “own” pointer elements stored in it.
//!
//! When the vector is destroyed, `delete` will be called on its pointer
//! elements.
//!
//! \note No attempt is made to `delete` elements that are removed from the
//! vector by other means, such as replacement or `clear()`.
template <typename T>
class PointerVector : public PointerContainer<std::vector<T*> > {};
class PointerVector : public PointerContainer<std::vector<T*>> {};
} // namespace crashpad