Bring Doxygen comment syntax in sync with LLVM coding style.

This changes '@' prefix to '\'.

llvm-svn: 355841

6 files changed, 55 insertions, 55 deletions

diff --git a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.cpp b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.cpp
index a96c795e450..e6deab8cd27 100644
--- a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.cpp
+++ b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.cpp
@@ -243,9 +243,9 @@ void DynamicLoaderHexagonDYLD::UpdateLoadedSections(ModuleSP module,
   }
 }
 
-/// Removes the loaded sections from the target in @p module.
+/// Removes the loaded sections from the target in \p module.
 ///
-/// @param module The module to traverse.
+/// \param module The module to traverse.
 void DynamicLoaderHexagonDYLD::UnloadSections(const ModuleSP module) {
   Target &target = m_process->GetTarget();
   const SectionList *sections = GetSectionListFromModule(module);
diff --git a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.h b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.h
index 3fa9a47ce6b..b9b0a93e495 100644
--- a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.h
+++ b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.h
@@ -86,21 +86,21 @@ protected:
   /// of loaded modules.
   void RefreshModules();
 
-  /// Updates the load address of every allocatable section in @p module.
+  /// Updates the load address of every allocatable section in \p module.
   ///
-  /// @param module The module to traverse.
+  /// \param module The module to traverse.
   ///
-  /// @param link_map_addr The virtual address of the link map for the @p
+  /// \param link_map_addr The virtual address of the link map for the @p
   /// module.
   ///
-  /// @param base_addr The virtual base address @p module is loaded at.
+  /// \param base_addr The virtual base address \p module is loaded at.
   void UpdateLoadedSections(lldb::ModuleSP module, lldb::addr_t link_map_addr,
                             lldb::addr_t base_addr,
                             bool base_addr_is_offset) override;
 
-  /// Removes the loaded sections from the target in @p module.
+  /// Removes the loaded sections from the target in \p module.
   ///
-  /// @param module The module to traverse.
+  /// \param module The module to traverse.
   void UnloadSections(const lldb::ModuleSP module) override;
 
   /// Callback routine invoked when we hit the breakpoint on process entry.
diff --git a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.h b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.h
index aa1e5c10b8e..70fc12b7fab 100644
--- a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.h
+++ b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.h
@@ -21,7 +21,7 @@ namespace lldb_private {
 class Process;
 }
 
-/// @class HexagonDYLDRendezvous
+/// \class HexagonDYLDRendezvous
 /// Interface to the runtime linker.
 ///
 /// A structure is present in a processes memory space which is updated by the
@@ -65,36 +65,36 @@ public:
   /// This method should be called once one start up, then once each time the
   /// runtime linker enters the function given by GetBreakAddress().
   ///
-  /// @returns true on success and false on failure.
+  /// \returns true on success and false on failure.
   ///
-  /// @see GetBreakAddress().
+  /// \see GetBreakAddress().
   bool Resolve();
 
-  /// @returns true if this rendezvous has been located in the inferiors
+  /// \returns true if this rendezvous has been located in the inferiors
   /// address space and false otherwise.
   bool IsValid();
 
-  /// @returns the address of the rendezvous structure in the inferiors
+  /// \returns the address of the rendezvous structure in the inferiors
   /// address space.
   lldb::addr_t GetRendezvousAddress() const { return m_rendezvous_addr; }
 
   /// Provide the dyld structure address
   void SetRendezvousAddress(lldb::addr_t);
 
-  /// @returns the version of the rendezvous protocol being used.
+  /// \returns the version of the rendezvous protocol being used.
   uint64_t GetVersion() const { return m_current.version; }
 
-  /// @returns address in the inferiors address space containing the linked
+  /// \returns address in the inferiors address space containing the linked
   /// list of shared object descriptors.
   lldb::addr_t GetLinkMapAddress() const { return m_current.map_addr; }
 
   /// A breakpoint should be set at this address and Resolve called on each
   /// hit.
   ///
-  /// @returns the address of a function called by the runtime linker each
+  /// \returns the address of a function called by the runtime linker each
   /// time a module is loaded/unloaded, or about to be loaded/unloaded.
   ///
-  /// @see Resolve()
+  /// \see Resolve()
   lldb::addr_t GetBreakAddress() const { return m_current.brk; }
 
   /// In hexagon it is possible that we can know the dyld breakpoint without
@@ -105,18 +105,18 @@ public:
   /// Returns the current state of the rendezvous structure.
   uint64_t GetState() const { return m_current.state; }
 
-  /// @returns the base address of the runtime linker in the inferiors address
+  /// \returns the base address of the runtime linker in the inferiors address
   /// space.
   lldb::addr_t GetLDBase() const { return m_current.ldbase; }
 
-  /// @returns the thread layout metadata from the inferiors thread library.
+  /// \returns the thread layout metadata from the inferiors thread library.
   const ThreadInfo &GetThreadInfo();
 
-  /// @returns true if modules have been loaded into the inferior since the
+  /// \returns true if modules have been loaded into the inferior since the
   /// last call to Resolve().
   bool ModulesDidLoad() const { return !m_added_soentries.empty(); }
 
-  /// @returns true if modules have been unloaded from the inferior since the
+  /// \returns true if modules have been unloaded from the inferior since the
   /// last call to Resolve().
   bool ModulesDidUnload() const { return !m_removed_soentries.empty(); }
 
@@ -124,7 +124,7 @@ public:
 
   /// Constants describing the state of the rendezvous.
   ///
-  /// @see GetState().
+  /// \see GetState().
   enum RendezvousState {
     eConsistent = 0,
     eAdd,
@@ -207,15 +207,15 @@ protected:
   /// Threading metadata read from the inferior.
   ThreadInfo m_thread_info;
 
-  /// Reads an unsigned integer of @p size bytes from the inferior's address
-  /// space starting at @p addr.
+  /// Reads an unsigned integer of \p size bytes from the inferior's address
+  /// space starting at \p addr.
   ///
-  /// @returns addr + size if the read was successful and false otherwise.
+  /// \returns addr + size if the read was successful and false otherwise.
   lldb::addr_t ReadWord(lldb::addr_t addr, uint64_t *dst, size_t size);
 
-  /// Reads an address from the inferior's address space starting at @p addr.
+  /// Reads an address from the inferior's address space starting at \p addr.
   ///
-  /// @returns addr + target address size if the read was successful and
+  /// \returns addr + target address size if the read was successful and
   /// 0 otherwise.
   lldb::addr_t ReadPointer(lldb::addr_t addr, lldb::addr_t *dst);
 
@@ -223,7 +223,7 @@ protected:
   /// addr.
   std::string ReadStringFromMemory(lldb::addr_t addr);
 
-  /// Reads an SOEntry starting at @p addr.
+  /// Reads an SOEntry starting at \p addr.
   bool ReadSOEntryFromMemory(lldb::addr_t addr, SOEntry &entry);
 
   /// Updates the current set of SOEntries, the set of added entries, and the
diff --git a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/AuxVector.h b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/AuxVector.h
index af61958efb8..cf32d9cd30f 100644
--- a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/AuxVector.h
+++ b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/AuxVector.h
@@ -17,7 +17,7 @@ namespace lldb_private {
 class DataExtractor;
 }
 
-/// @class AuxVector
+/// \class AuxVector
 /// Represents a processes auxiliary vector.
 ///
 /// When a process is loaded on Linux a vector of values is placed onto the
diff --git a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.h b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.h
index 8c761e781c3..993e62f5e9f 100644
--- a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.h
+++ b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.h
@@ -24,7 +24,7 @@ namespace lldb_private {
 class Process;
 }
 
-/// @class DYLDRendezvous
+/// \class DYLDRendezvous
 /// Interface to the runtime linker.
 ///
 /// A structure is present in a processes memory space which is updated by the
@@ -66,50 +66,50 @@ public:
   /// This method should be called once one start up, then once each time the
   /// runtime linker enters the function given by GetBreakAddress().
   ///
-  /// @returns true on success and false on failure.
+  /// \returns true on success and false on failure.
   ///
-  /// @see GetBreakAddress().
+  /// \see GetBreakAddress().
   bool Resolve();
 
-  /// @returns true if this rendezvous has been located in the inferiors
+  /// \returns true if this rendezvous has been located in the inferiors
   /// address space and false otherwise.
   bool IsValid();
 
-  /// @returns the address of the rendezvous structure in the inferiors
+  /// \returns the address of the rendezvous structure in the inferiors
   /// address space.
   lldb::addr_t GetRendezvousAddress() const { return m_rendezvous_addr; }
 
-  /// @returns the version of the rendezvous protocol being used.
+  /// \returns the version of the rendezvous protocol being used.
   uint64_t GetVersion() const { return m_current.version; }
 
-  /// @returns address in the inferiors address space containing the linked
+  /// \returns address in the inferiors address space containing the linked
   /// list of shared object descriptors.
   lldb::addr_t GetLinkMapAddress() const { return m_current.map_addr; }
 
   /// A breakpoint should be set at this address and Resolve called on each
   /// hit.
   ///
-  /// @returns the address of a function called by the runtime linker each
+  /// \returns the address of a function called by the runtime linker each
   /// time a module is loaded/unloaded, or about to be loaded/unloaded.
   ///
-  /// @see Resolve()
+  /// \see Resolve()
   lldb::addr_t GetBreakAddress() const { return m_current.brk; }
 
   /// Returns the current state of the rendezvous structure.
   uint64_t GetState() const { return m_current.state; }
 
-  /// @returns the base address of the runtime linker in the inferiors address
+  /// \returns the base address of the runtime linker in the inferiors address
   /// space.
   lldb::addr_t GetLDBase() const { return m_current.ldbase; }
 
-  /// @returns the thread layout metadata from the inferiors thread library.
+  /// \returns the thread layout metadata from the inferiors thread library.
   const ThreadInfo &GetThreadInfo();
 
-  /// @returns true if modules have been loaded into the inferior since the
+  /// \returns true if modules have been loaded into the inferior since the
   /// last call to Resolve().
   bool ModulesDidLoad() const { return !m_added_soentries.empty(); }
 
-  /// @returns true if modules have been unloaded from the inferior since the
+  /// \returns true if modules have been unloaded from the inferior since the
   /// last call to Resolve().
   bool ModulesDidUnload() const { return !m_removed_soentries.empty(); }
 
@@ -117,7 +117,7 @@ public:
 
   /// Constants describing the state of the rendezvous.
   ///
-  /// @see GetState().
+  /// \see GetState().
   enum RendezvousState { eConsistent, eAdd, eDelete };
 
   /// Structure representing the shared objects currently loaded into the
@@ -201,15 +201,15 @@ protected:
   /// Threading metadata read from the inferior.
   ThreadInfo m_thread_info;
 
-  /// Reads an unsigned integer of @p size bytes from the inferior's address
-  /// space starting at @p addr.
+  /// Reads an unsigned integer of \p size bytes from the inferior's address
+  /// space starting at \p addr.
   ///
-  /// @returns addr + size if the read was successful and false otherwise.
+  /// \returns addr + size if the read was successful and false otherwise.
   lldb::addr_t ReadWord(lldb::addr_t addr, uint64_t *dst, size_t size);
 
-  /// Reads an address from the inferior's address space starting at @p addr.
+  /// Reads an address from the inferior's address space starting at \p addr.
   ///
-  /// @returns addr + target address size if the read was successful and
+  /// \returns addr + target address size if the read was successful and
   /// 0 otherwise.
   lldb::addr_t ReadPointer(lldb::addr_t addr, lldb::addr_t *dst);
 
@@ -217,7 +217,7 @@ protected:
   /// addr.
   std::string ReadStringFromMemory(lldb::addr_t addr);
 
-  /// Reads an SOEntry starting at @p addr.
+  /// Reads an SOEntry starting at \p addr.
   bool ReadSOEntryFromMemory(lldb::addr_t addr, SOEntry &entry);
 
   /// Updates the current set of SOEntries, the set of added entries, and the
diff --git a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.h b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.h
index 9141138f5f0..1a2d40042c1 100644
--- a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.h
+++ b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.h
@@ -102,21 +102,21 @@ protected:
   /// of loaded modules.
   void RefreshModules();
 
-  /// Updates the load address of every allocatable section in @p module.
+  /// Updates the load address of every allocatable section in \p module.
   ///
-  /// @param module The module to traverse.
+  /// \param module The module to traverse.
   ///
-  /// @param link_map_addr The virtual address of the link map for the @p
+  /// \param link_map_addr The virtual address of the link map for the @p
   /// module.
   ///
-  /// @param base_addr The virtual base address @p module is loaded at.
+  /// \param base_addr The virtual base address \p module is loaded at.
   void UpdateLoadedSections(lldb::ModuleSP module, lldb::addr_t link_map_addr,
                             lldb::addr_t base_addr,
                             bool base_addr_is_offset) override;
 
-  /// Removes the loaded sections from the target in @p module.
+  /// Removes the loaded sections from the target in \p module.
   ///
-  /// @param module The module to traverse.
+  /// \param module The module to traverse.
   void UnloadSections(const lldb::ModuleSP module) override;
 
   /// Resolves the entry point for the current inferior process and sets a