mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-09 14:06:33 +00:00
Fix a few pieces of documentation
These problems were noticed while perusing http://docs.crashpad.googlecode.com/git/doxygen/namespacecrashpad.html R=scottmg@chromium.org Review URL: https://codereview.chromium.org/1278423002 .
This commit is contained in:
parent
402bb216fb
commit
eb7ca8c374
@ -71,7 +71,7 @@ bool CrashpadClient::StartHandler(
|
||||
return false;
|
||||
}
|
||||
|
||||
bool SetHandler(const std::string& ipc_port) {
|
||||
bool CrashpadClient::SetHandler(const std::string& ipc_port) {
|
||||
// TODO (cpu): Contact the handler and obtain g_signal_exception and
|
||||
// g_wait_termination.
|
||||
return false;
|
||||
|
@ -34,10 +34,12 @@ struct RegistrationRequest {
|
||||
#pragma pack(pop)
|
||||
|
||||
#pragma pack(push, 1)
|
||||
//! \brief A client registration response. See
|
||||
//! https://msdn.microsoft.com/en-us/library/windows/desktop/aa384203 for
|
||||
//! details on communicating handle values between 32-bit and 64-bit
|
||||
//! processes.
|
||||
//! \brief A client registration response.
|
||||
//!
|
||||
//! See <a
|
||||
//! href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa384203">Interprocess
|
||||
//! Communication Between 32-bit and 64-bit Applications</a> for details on
|
||||
//! communicating handle values between processes of varying bitness.
|
||||
struct RegistrationResponse {
|
||||
//! \brief An event `HANDLE`, valid in the client process, that should be
|
||||
//! signaled to request a crash report. 64-bit clients should convert the
|
||||
|
@ -1986,7 +1986,10 @@ INCLUDE_FILE_PATTERNS =
|
||||
# recursively expanded use the := operator instead of the = operator.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
PREDEFINED = DOXYGEN \
|
||||
PREDEFINED = ALIGNAS(x)= \
|
||||
DOXYGEN \
|
||||
MSVC_POP_WARNING()= \
|
||||
MSVC_PUSH_DISABLE_WARNING(x)= \
|
||||
__attribute__(x)=
|
||||
|
||||
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
|
||||
|
@ -26,7 +26,7 @@
|
||||
|
||||
namespace crashpad {
|
||||
|
||||
//! \brief Accesses information about another process, identified by a HANDLE.
|
||||
//! \brief Accesses information about another process, identified by a `HANDLE`.
|
||||
class ProcessReaderWin {
|
||||
public:
|
||||
//! \brief Contains information about a thread that belongs to a process.
|
||||
@ -50,8 +50,8 @@ class ProcessReaderWin {
|
||||
//! \brief Initializes this object. This method must be called before any
|
||||
//! other.
|
||||
//!
|
||||
//! \param[in] process Process handle, must have PROCESS_QUERY_INFORMATION,
|
||||
//! PROCESS_VM_READ, and PROCESS_DUP_HANDLE access.
|
||||
//! \param[in] process Process handle, must have `PROCESS_QUERY_INFORMATION`,
|
||||
//! `PROCESS_VM_READ`, and `PROCESS_DUP_HANDLE` access.
|
||||
//!
|
||||
//! \return `true` on success, indicating that this object will respond
|
||||
//! validly to further method calls. `false` on failure. On failure, no
|
||||
|
@ -23,10 +23,10 @@ namespace crashpad {
|
||||
//! semantics matching the underlying platform (POSIX or Windows).
|
||||
class FileSeekerInterface {
|
||||
public:
|
||||
//! \brief Wraps LoggingFileSeek() or provides an alternate implementation
|
||||
//! \brief Wraps LoggingSeekFile() or provides an alternate implementation
|
||||
//! with identical semantics.
|
||||
//!
|
||||
//! \return The return value of LoggingFileSeek(). `-1` on failure,
|
||||
//! \return The return value of LoggingSeekFile(). `-1` on failure,
|
||||
//! with an error message logged.
|
||||
virtual FileOffset Seek(FileOffset offset, int whence) = 0;
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user