From 84d9952ebf32109f32c2287d02d204554f4c648d Mon Sep 17 00:00:00 2001 From: Mark Mentovai Date: Tue, 16 Sep 2014 17:37:41 -0400 Subject: [PATCH] Use `backticks` more uniformly in MachOImage*Reader Doxygen documentation. R=rsesek@chromium.org Review URL: https://codereview.chromium.org/574723002 --- util/mac/mach_o_image_reader.h | 22 +++++++++++----------- util/mac/mach_o_image_segment_reader.h | 14 +++++++------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/util/mac/mach_o_image_reader.h b/util/mac/mach_o_image_reader.h index fc7be578..d2e9c135 100644 --- a/util/mac/mach_o_image_reader.h +++ b/util/mac/mach_o_image_reader.h @@ -76,19 +76,19 @@ class MachOImageReader { //! This is the value passed as \a address to Initialize(). mach_vm_address_t Address() const { return address_; } - //! \brief Returns the mapped size of the Mach-O image’s __TEXT segment. + //! \brief Returns the mapped size of the Mach-O image’s `__TEXT` segment. //! - //! Note that this is returns only the size of the __TEXT segment, not of any - //! other segment. This is because the interface only allows one load address - //! and size to be reported, but Mach-O image files may consist of multiple - //! discontiguous segments. By convention, the __TEXT segment is always mapped - //! at the beginning of a Mach-O image file, and it is the most useful for the - //! expected intended purpose of collecting data to obtain stack backtraces. - //! The implementation insists during initialization that the __TEXT segment - //! be mapped at the beginning of the file. + //! Note that this is returns only the size of the `__TEXT` segment, not of + //! any other segment. This is because the interface only allows one load + //! address and size to be reported, but Mach-O image files may consist of + //! multiple discontiguous segments. By convention, the `__TEXT` segment is + //! always mapped at the beginning of a Mach-O image file, and it is the most + //! useful for the expected intended purpose of collecting data to obtain + //! stack backtraces. The implementation insists during initialization that + //! the `__TEXT` segment be mapped at the beginning of the file. //! //! In practice, discontiguous segments are only found for images that have - //! loaded out of the dyld shared cache, but the __TEXT segment’s size is + //! loaded out of the dyld shared cache, but the `__TEXT` segment’s size is //! returned for modules that loaded with contiguous segments as well for //! consistency. mach_vm_size_t Size() const { return size_; } @@ -96,7 +96,7 @@ class MachOImageReader { //! \brief Returns the Mach-O image’s “slide,” the difference between its //! actual load address and its preferred load address. //! - //! “Slide” is computed by subtracting the __TEXT segment’s preferred load + //! “Slide” is computed by subtracting the `__TEXT` segment’s preferred load //! address from its actual load address. It will be reported as a positive //! offset when the actual load address is greater than the preferred load //! address. The preferred load address is taken to be the segment’s reported diff --git a/util/mac/mach_o_image_segment_reader.h b/util/mac/mach_o_image_segment_reader.h index 4f9d02de..bc1bb761 100644 --- a/util/mac/mach_o_image_segment_reader.h +++ b/util/mac/mach_o_image_segment_reader.h @@ -29,11 +29,11 @@ namespace crashpad { -//! \brief A reader for LC_SEGMENT or LC_SEGMENT_64 load commands in Mach-O +//! \brief A reader for `LC_SEGMENT` or `LC_SEGMENT_64` load commands in Mach-O //! images mapped into another process. //! -//! This class is capable of reading both LC_SEGMENT and LC_SEGMENT_64 based on -//! the bitness of the remote process. +//! This class is capable of reading both `LC_SEGMENT` and `LC_SEGMENT_64` based +//! on the bitness of the remote process. //! //! A MachOImageSegmentReader will normally be instantiated by a //! MachOImageReader. @@ -49,7 +49,7 @@ class MachOImageSegmentReader { //! //! \param[in] process_reader The reader for the remote process. //! \param[in] load_command_address The address, in the remote process’ - //! address space, where the LC_SEGMENT or LC_SEGMENT_64 load command + //! address space, where the `LC_SEGMENT` or `LC_SEGMENT_64` load command //! to be read is located. This address is determined by a Mach-O image //! reader, such as MachOImageReader, as it walks Mach-O load commands. //! \param[in] load_command_info A string to be used in logged messages. This @@ -118,13 +118,13 @@ class MachOImageSegmentReader { //! The file offset is the difference between the beginning of the //! `mach_header` or `mach_header_64` and the beginning of the segment’s //! mapped region. For segments that are not mapped from a file (such as - //! `"__PAGEZERO"` segments), this will be `0`. + //! `__PAGEZERO` segments), this will be `0`. mach_vm_size_t fileoff() const { return segment_command_.fileoff; } //! \brief Returns the number of sections in the segment. //! //! This will return `0` for a segment without any sections, typical for - //! `"__PAGEZERO"` and `"__LINKEDIT"` segments. + //! `__PAGEZERO` and `__LINKEDIT` segments. //! //! Although the Mach-O file format uses a `uint32_t` for this field, there is //! an overall limit of 255 sections in an entire Mach-O image file (not just @@ -191,7 +191,7 @@ class MachOImageSegmentReader { //! Returns whether the segment slides. //! - //! Most segments slide, but the __PAGEZERO segment does not, it grows + //! Most segments slide, but the `__PAGEZERO` segment does not, it grows //! instead. This method identifies non-sliding segments in the same way that //! the kernel does. bool SegmentSlides() const;