mirror of
https://github.com/chromium/crashpad.git
synced 2024-12-28 15:50:26 +08:00
acabe35928
This makes Doxygen’s output more actionable by setting QUIET = YES to suppress verbose progress spew, and WARN_IF_UNDOCUMENTED = NO to prevent warnings for undocumented classes and members from being generated. The latter is too noisy, producing 721 warnings in the current codebase. The remaining warnings produced by Doxygen were useful and actionable. They fell into two categories: abuses of Doxygen’s markup syntax, and missing (or misspelled) parameter documentation. In a small number of cases, pass-through parameters had intentionally been left undocumented. In these cases, they are now given blank \param descriptions. This is not optimal, but there doesn’t appear to be any other way to tell Doxygen to allow a single parameter to be undocumented. Some tricky Doxygen errors were resolved by asking it to not enter directiores that we do not provide documentation in (such as the “on-platform” compat directories, compat/mac and compat/win, as well as compat/non_cxx11_lib) while allowing it to enter the “off-platform” directories that we do document (compat/non_mac and compat/non_win). A Doxygen run (doc/support/generate_doxygen.sh) now produces no output at all. It would produce warnings if any were triggered. Not directly related, but still relevant to documentation, doc/support/generate.sh is updated to remove temporary removals of now-extinct files and directories. doc/appengine/README is updated so that a consistent path to “goapp” is used throughout the file. Change-Id: I300730c04de4d3340551ea3086ca70cc5ff862d1 Reviewed-on: https://chromium-review.googlesource.com/408812 Reviewed-by: Robert Sesek <rsesek@chromium.org>
73 lines
2.7 KiB
C++
73 lines
2.7 KiB
C++
// Copyright 2015 The Crashpad Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef CRASHPAD_SNAPSHOT_WIN_PE_IMAGE_ANNOTATIONS_READER_H_
|
|
#define CRASHPAD_SNAPSHOT_WIN_PE_IMAGE_ANNOTATIONS_READER_H_
|
|
|
|
#include <map>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "base/macros.h"
|
|
|
|
namespace crashpad {
|
|
|
|
class PEImageReader;
|
|
class ProcessReaderWin;
|
|
|
|
//! \brief A reader of annotations stored in a PE image mapped into another
|
|
//! process.
|
|
//!
|
|
//! These annotations are stored for the benefit of crash reporters, and provide
|
|
//! information thought to be potentially useful for crash analysis.
|
|
//!
|
|
//! Currently, this class can decode information stored only in the CrashpadInfo
|
|
//! structure. This format is used by Crashpad clients. The "simple annotations"
|
|
//! are recovered from any module with a compatible data section, and are
|
|
//! included in the annotations returned by SimpleMap().
|
|
class PEImageAnnotationsReader {
|
|
public:
|
|
//! \brief Constructs the object.
|
|
//!
|
|
//! \param[in] process_reader The reader for the remote process.
|
|
//! \param[in] pe_image_reader The PEImageReader for the PE image file
|
|
//! contained within the remote process.
|
|
//! \param[in] name The module's name, a string to be used in logged messages.
|
|
//! This string is for diagnostic purposes only, and may be empty.
|
|
PEImageAnnotationsReader(ProcessReaderWin* process_reader,
|
|
const PEImageReader* pe_image_reader,
|
|
const std::wstring& name);
|
|
~PEImageAnnotationsReader() {}
|
|
|
|
//! \brief Returns the module's annotations that are organized as key-value
|
|
//! pairs, where all keys and values are strings.
|
|
std::map<std::string, std::string> SimpleMap() const;
|
|
|
|
private:
|
|
// Reads CrashpadInfo::simple_annotations_ on behalf of SimpleMap().
|
|
template <class Traits>
|
|
void ReadCrashpadSimpleAnnotations(
|
|
std::map<std::string, std::string>* simple_map_annotations) const;
|
|
|
|
std::wstring name_;
|
|
ProcessReaderWin* process_reader_; // weak
|
|
const PEImageReader* pe_image_reader_; // weak
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(PEImageAnnotationsReader);
|
|
};
|
|
|
|
} // namespace crashpad
|
|
|
|
#endif // CRASHPAD_SNAPSHOT_WIN_PE_IMAGE_ANNOTATIONS_READER_H_
|