From 4bd97bb6db2a30f4e10c456dbc24dac7e557b277 Mon Sep 17 00:00:00 2001 From: Mark Mentovai Date: Thu, 19 Mar 2015 18:04:38 -0400 Subject: [PATCH] Document CrashpadInfo::set_simple_annotations(). R=rsesek@chromium.org Review URL: https://codereview.chromium.org/1016613003 --- client/crashpad_info.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/client/crashpad_info.h b/client/crashpad_info.h index 2caf7c62..ecd1195b 100644 --- a/client/crashpad_info.h +++ b/client/crashpad_info.h @@ -38,6 +38,20 @@ struct CrashpadInfo { CrashpadInfo(); + //! \brief Sets the simple annotations dictionary. + //! + //! Simple annotations set on a CrashpadInfo structure are interpreted by + //! Crashpad as module-level annotations. + //! + //! Annotations may exist in \a simple_annotations at the time that this + //! method is called, or they may be added, removed, or modified in \a + //! simple_annotations after this method is called. + //! + //! \param[in] simple_annotations A dictionary that maps string keys to string + //! values. The CrashpadInfo object does not take ownership of the + //! SimpleStringDictionary object. It is the caller’s responsibility to + //! ensure that this pointer remains valid while it is in effect for a + //! CrashpadInfo object. void set_simple_annotations(SimpleStringDictionary* simple_annotations) { simple_annotations_ = simple_annotations; }