[llvm] e5906f6 - [DWARFLinker] Fix typo and improve comments (NFC)

[Jonas Devlieghere via llvm-commits]

Author: Jonas Devlieghere
Date: 2023-02-09T13:20:52-08:00
New Revision: e5906f64a63d064e6a9ea2c46ebc9c285ca02bd1

URL: https://github.com/llvm/llvm-project/commit/e5906f64a63d064e6a9ea2c46ebc9c285ca02bd1
DIFF: https://github.com/llvm/llvm-project/commit/e5906f64a63d064e6a9ea2c46ebc9c285ca02bd1.diff

LOG: [DWARFLinker] Fix typo and improve comments (NFC)

Fix a typo and improve comments to match the LLVM coding style.

Added: 
    

Modified: 
    llvm/include/llvm/DWARFLinker/DWARFLinker.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/DWARFLinker/DWARFLinker.h b/llvm/include/llvm/DWARFLinker/DWARFLinker.h
index 5b2f798b784a4..d12b6d1f5f2f9 100644
--- a/llvm/include/llvm/DWARFLinker/DWARFLinker.h
+++ b/llvm/include/llvm/DWARFLinker/DWARFLinker.h
@@ -205,8 +205,8 @@ class DwarfEmitter {
 
 using UnitListTy = std::vector<std::unique_ptr<CompileUnit>>;
 
-/// this class represents DWARF information for source file
-/// and it`s address map.
+/// This class represents DWARF information for source file
+/// and its address map.
 class DWARFFile {
 public:
   DWARFFile(StringRef Name, DWARFContext *Dwarf, AddressesMap *Addresses,
@@ -214,13 +214,16 @@ class DWARFFile {
       : FileName(Name), Dwarf(Dwarf), Addresses(Addresses), Warnings(Warnings) {
   }
 
-  /// object file name.
+  /// The object file name.
   StringRef FileName;
-  /// source DWARF information.
+
+  /// The source DWARF information.
   DWARFContext *Dwarf = nullptr;
-  /// helpful address information(list of valid address ranges, relocations).
+
+  /// Helpful address information(list of valid address ranges, relocations).
   AddressesMap *Addresses = nullptr;
-  /// warnings for object file.
+
+  /// Warnings for this object file.
   const std::vector<std::string> &Warnings;
 };