1 files changed, 29 insertions, 52 deletions

diff --git a/include/lldb/API/SBModule.h b/include/lldb/API/SBModule.h
index 7a10e9fc96b3..d2b6a18db84d 100644
--- a/include/lldb/API/SBModule.h
+++ b/include/lldb/API/SBModule.h
@@ -1,9 +1,8 @@
 //===-- SBModule.h ----------------------------------------------*- C++ -*-===//
 //
-//                     The LLVM Compiler Infrastructure
-//
-// This file is distributed under the University of Illinois Open Source
-// License. See LICENSE.TXT for details.
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
@@ -32,23 +31,22 @@ public:
 
   ~SBModule();
 
+  explicit operator bool() const;
+
   bool IsValid() const;
 
   void Clear();
 
-  //------------------------------------------------------------------
   /// Get const accessor for the module file specification.
   ///
   /// This function returns the file for the module on the host system
   /// that is running LLDB. This can differ from the path on the
   /// platform since we might be doing remote debugging.
   ///
-  /// @return
+  /// \return
   ///     A const reference to the file specification object.
-  //------------------------------------------------------------------
   lldb::SBFileSpec GetFileSpec() const;
 
-  //------------------------------------------------------------------
   /// Get accessor for the module platform file specification.
   ///
   /// Platform file refers to the path of the module as it is known on
@@ -60,14 +58,12 @@ public:
   /// '/tmp/lldb/platform-cache/remote.host.computer/usr/lib/liba.dylib'
   /// The file could also be cached in a local developer kit directory.
   ///
-  /// @return
+  /// \return
   ///     A const reference to the file specification object.
-  //------------------------------------------------------------------
   lldb::SBFileSpec GetPlatformFileSpec() const;
 
   bool SetPlatformFileSpec(const lldb::SBFileSpec &platform_file);
 
-  //------------------------------------------------------------------
   /// Get accessor for the remote install path for a module.
   ///
   /// When debugging to a remote platform by connecting to a remote
@@ -76,12 +72,10 @@ public:
   /// the target will install this module on the remote platform prior
   /// to launching.
   ///
-  /// @return
+  /// \return
   ///     A file specification object.
-  //------------------------------------------------------------------
   lldb::SBFileSpec GetRemoteInstallFileSpec();
 
-  //------------------------------------------------------------------
   /// Set accessor for the remote install path for a module.
   ///
   /// When debugging to a remote platform by connecting to a remote
@@ -96,9 +90,8 @@ public:
   /// or "./usr/lib", then the install path will be resolved using
   /// the platform's current working directory as the base path.
   ///
-  /// @param[in] file
+  /// \param[in] file
   ///     A file specification object.
-  //------------------------------------------------------------------
   bool SetRemoteInstallFileSpec(lldb::SBFileSpec &file);
 
   lldb::ByteOrder GetByteOrder();
@@ -129,18 +122,16 @@ public:
 
   lldb::SBCompileUnit GetCompileUnitAtIndex(uint32_t);
 
-  //------------------------------------------------------------------
   /// Find compile units related to *this module and passed source
   /// file.
   ///
-  /// @param[in] sb_file_spec
+  /// \param[in] sb_file_spec
   ///     A lldb::SBFileSpec object that contains source file
   ///     specification.
   ///
-  /// @return
+  /// \return
   ///     A lldb::SBSymbolContextList that gets filled in with all of
   ///     the symbol contexts for all the matches.
-  //------------------------------------------------------------------
   lldb::SBSymbolContextList
   FindCompileUnits(const lldb::SBFileSpec &sb_file_spec);
 
@@ -157,59 +148,53 @@ public:
   size_t GetNumSections();
 
   lldb::SBSection GetSectionAtIndex(size_t idx);
-  //------------------------------------------------------------------
   /// Find functions by name.
   ///
-  /// @param[in] name
+  /// \param[in] name
   ///     The name of the function we are looking for.
   ///
-  /// @param[in] name_type_mask
+  /// \param[in] name_type_mask
   ///     A logical OR of one or more FunctionNameType enum bits that
   ///     indicate what kind of names should be used when doing the
   ///     lookup. Bits include fully qualified names, base names,
   ///     C++ methods, or ObjC selectors.
   ///     See FunctionNameType for more details.
   ///
-  /// @return
+  /// \return
   ///     A lldb::SBSymbolContextList that gets filled in with all of
   ///     the symbol contexts for all the matches.
-  //------------------------------------------------------------------
   lldb::SBSymbolContextList
   FindFunctions(const char *name,
                 uint32_t name_type_mask = lldb::eFunctionNameTypeAny);
 
-  //------------------------------------------------------------------
   /// Find global and static variables by name.
   ///
-  /// @param[in] target
+  /// \param[in] target
   ///     A valid SBTarget instance representing the debuggee.
   ///
-  /// @param[in] name
+  /// \param[in] name
   ///     The name of the global or static variable we are looking
   ///     for.
   ///
-  /// @param[in] max_matches
+  /// \param[in] max_matches
   ///     Allow the number of matches to be limited to \a max_matches.
   ///
-  /// @return
+  /// \return
   ///     A list of matched variables in an SBValueList.
-  //------------------------------------------------------------------
   lldb::SBValueList FindGlobalVariables(lldb::SBTarget &target,
                                         const char *name, uint32_t max_matches);
 
-  //------------------------------------------------------------------
   /// Find the first global (or static) variable by name.
   ///
-  /// @param[in] target
+  /// \param[in] target
   ///     A valid SBTarget instance representing the debuggee.
   ///
-  /// @param[in] name
+  /// \param[in] name
   ///     The name of the global or static variable we are looking
   ///     for.
   ///
-  /// @return
+  /// \return
   ///     An SBValue that gets filled in with the found variable (if any).
-  //------------------------------------------------------------------
   lldb::SBValue FindFirstGlobalVariable(lldb::SBTarget &target,
                                         const char *name);
 
@@ -217,7 +202,6 @@ public:
 
   lldb::SBTypeList FindTypes(const char *type);
 
-  //------------------------------------------------------------------
   /// Get a type using its type ID.
   ///
   /// Each symbol file reader will assign different user IDs to their
@@ -226,34 +210,30 @@ public:
   ///
   /// For DWARF debug info, the type ID is the DIE offset.
   ///
-  /// @param[in] uid
+  /// \param[in] uid
   ///     The type user ID.
   ///
-  /// @return
+  /// \return
   ///     An SBType for the given type ID, or an empty SBType if the
   ///     type was not found.
-  //------------------------------------------------------------------
   lldb::SBType GetTypeByID(lldb::user_id_t uid);
 
   lldb::SBType GetBasicType(lldb::BasicType type);
 
-  //------------------------------------------------------------------
   /// Get all types matching \a type_mask from debug info in this
   /// module.
   ///
-  /// @param[in] type_mask
+  /// \param[in] type_mask
   ///     A bitfield that consists of one or more bits logically OR'ed
   ///     together from the lldb::TypeClass enumeration. This allows
   ///     you to request only structure types, or only class, struct
   ///     and union types. Passing in lldb::eTypeClassAny will return
   ///     all types found in the debug information for this module.
   ///
-  /// @return
+  /// \return
   ///     A list of types in this module that match \a type_mask
-  //------------------------------------------------------------------
   lldb::SBTypeList GetTypes(uint32_t type_mask = lldb::eTypeClassAny);
 
-  //------------------------------------------------------------------
   /// Get the module version numbers.
   ///
   /// Many object files have a set of version numbers that describe
@@ -267,7 +247,7 @@ public:
   /// function with a value of \a versions and \a num_versions that
   /// has enough storage to store some or all version numbers.
   ///
-  /// @param[out] versions
+  /// \param[out] versions
   ///     A pointer to an array of uint32_t types that is \a num_versions
   ///     long. If this value is NULL, the return value will indicate
   ///     how many version numbers are required for a subsequent call
@@ -278,7 +258,7 @@ public:
   ///     will be filled with \a num_versions UINT32_MAX values
   ///     and zero will be returned.
   ///
-  /// @param[in] num_versions
+  /// \param[in] num_versions
   ///     The maximum number of entries to fill into \a versions. If
   ///     this value is zero, then the return value will indicate
   ///     how many version numbers there are in total so another call
@@ -288,14 +268,12 @@ public:
   ///     numbers in this object file, only \a num_versions will be
   ///     filled into \a versions (if \a versions is non-NULL).
   ///
-  /// @return
+  /// \return
   ///     This function always returns the number of version numbers
   ///     that this object file has regardless of the number of
   ///     version numbers that were copied into \a versions.
-  //------------------------------------------------------------------
   uint32_t GetVersion(uint32_t *versions, uint32_t num_versions);
 
-  //------------------------------------------------------------------
   /// Get accessor for the symbol file specification.
   ///
   /// When debugging an object file an additional debug information can
@@ -303,9 +281,8 @@ public:
   /// like '/usr/lib/liba.dylib' then debug information can be located
   /// in folder like '/usr/lib/liba.dylib.dSYM/'.
   ///
-  /// @return
+  /// \return
   ///     A const reference to the file specification object.
-  //------------------------------------------------------------------
   lldb::SBFileSpec GetSymbolFileSpec() const;
 
   lldb::SBAddress GetObjectFileHeaderAddress() const;