Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(538)

Unified Diff: util/mac/mach_o_image_reader.h

Issue 574723002: Use `backticks` more uniformly in MachOImage*Reader Doxygen documentation (Closed) Base URL: https://chromium.googlesource.com/crashpad/crashpad@master
Patch Set: Created 6 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | util/mac/mach_o_image_segment_reader.h » ('j') | util/mac/mach_o_image_segment_reader.h » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: util/mac/mach_o_image_reader.h
diff --git a/util/mac/mach_o_image_reader.h b/util/mac/mach_o_image_reader.h
index fc7be578335ddc79981b2741737a012c13c3e13b..d2e9c135eefe0e1d6f07afa19d8095a2ba39b0ff 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
« no previous file with comments | « no previous file | util/mac/mach_o_image_segment_reader.h » ('j') | util/mac/mach_o_image_segment_reader.h » ('J')

Powered by Google App Engine
This is Rietveld 408576698