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:
Mark Mentovai 2015-08-10 12:23:50 -04:00
parent 402bb216fb
commit eb7ca8c374
5 changed files with 16 additions and 11 deletions

View File

@ -71,7 +71,7 @@ bool CrashpadClient::StartHandler(
return false; 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 // TODO (cpu): Contact the handler and obtain g_signal_exception and
// g_wait_termination. // g_wait_termination.
return false; return false;

View File

@ -34,10 +34,12 @@ struct RegistrationRequest {
#pragma pack(pop) #pragma pack(pop)
#pragma pack(push, 1) #pragma pack(push, 1)
//! \brief A client registration response. See //! \brief A client registration response.
//! https://msdn.microsoft.com/en-us/library/windows/desktop/aa384203 for //!
//! details on communicating handle values between 32-bit and 64-bit //! See <a
//! processes. //! 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 { struct RegistrationResponse {
//! \brief An event `HANDLE`, valid in the client process, that should be //! \brief An event `HANDLE`, valid in the client process, that should be
//! signaled to request a crash report. 64-bit clients should convert the //! signaled to request a crash report. 64-bit clients should convert the

View File

@ -1986,7 +1986,10 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator. # recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # 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)= __attribute__(x)=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this

View File

@ -26,7 +26,7 @@
namespace crashpad { namespace crashpad {
//! \brief Accesses information about another process, identified by a HANDLE. //! \brief Accesses information about another process, identified by a `HANDLE`.
class ProcessReaderWin { class ProcessReaderWin {
public: public:
//! \brief Contains information about a thread that belongs to a process. //! \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 //! \brief Initializes this object. This method must be called before any
//! other. //! other.
//! //!
//! \param[in] process Process handle, must have PROCESS_QUERY_INFORMATION, //! \param[in] process Process handle, must have `PROCESS_QUERY_INFORMATION`,
//! PROCESS_VM_READ, and PROCESS_DUP_HANDLE access. //! `PROCESS_VM_READ`, and `PROCESS_DUP_HANDLE` access.
//! //!
//! \return `true` on success, indicating that this object will respond //! \return `true` on success, indicating that this object will respond
//! validly to further method calls. `false` on failure. On failure, no //! validly to further method calls. `false` on failure. On failure, no

View File

@ -23,10 +23,10 @@ namespace crashpad {
//! semantics matching the underlying platform (POSIX or Windows). //! semantics matching the underlying platform (POSIX or Windows).
class FileSeekerInterface { class FileSeekerInterface {
public: public:
//! \brief Wraps LoggingFileSeek() or provides an alternate implementation //! \brief Wraps LoggingSeekFile() or provides an alternate implementation
//! with identical semantics. //! 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. //! with an error message logged.
virtual FileOffset Seek(FileOffset offset, int whence) = 0; virtual FileOffset Seek(FileOffset offset, int whence) = 0;