Bring Doxygen comment syntax in sync with LLVM coding style.

This changes '@' prefix to '\'.

llvm-svn: 355841

4 files changed, 50 insertions, 50 deletions

diff --git a/lldb/include/lldb/Interpreter/CommandInterpreter.h b/lldb/include/lldb/Interpreter/CommandInterpreter.h
index 49c5415ac44..e2fcd90b314 100644
--- a/lldb/include/lldb/Interpreter/CommandInterpreter.h
+++ b/lldb/include/lldb/Interpreter/CommandInterpreter.h
@@ -36,27 +36,27 @@ public:
   ///
   /// The meanings of the options in this object are:
   ///
-  /// @param[in] stop_on_continue
+  /// \param[in] stop_on_continue
   ///    If \b true, execution will end on the first command that causes the
   ///    process in the execution context to continue. If \b false, we won't
   ///    check the execution status.
-  /// @param[in] stop_on_error
+  /// \param[in] stop_on_error
   ///    If \b true, execution will end on the first command that causes an
   ///    error.
-  /// @param[in] stop_on_crash
+  /// \param[in] stop_on_crash
   ///    If \b true, when a command causes the target to run, and the end of the
   ///    run is a signal or exception, stop executing the commands.
-  /// @param[in] echo_commands
+  /// \param[in] echo_commands
   ///    If \b true, echo the command before executing it. If \b false, execute
   ///    silently.
-  /// @param[in] echo_comments
+  /// \param[in] echo_comments
   ///    If \b true, echo command even if it is a pure comment line. If
   ///    \b false, print no ouput in this case. This setting has an effect only
   ///    if \param echo_commands is \b true.
-  /// @param[in] print_results
+  /// \param[in] print_results
   ///    If \b true print the results of the command after executing it. If
   ///    \b false, execute silently.
-  /// @param[in] add_to_history
+  /// \param[in] add_to_history
   ///    If \b true add the commands to the command history. If \b false, don't
   ///    add them.
   //------------------------------------------------------------------
@@ -257,17 +257,17 @@ public:
   //------------------------------------------------------------------
   /// Execute a list of commands in sequence.
   ///
-  /// @param[in] commands
+  /// \param[in] commands
   ///    The list of commands to execute.
-  /// @param[in,out] context
+  /// \param[in,out] context
   ///    The execution context in which to run the commands. Can be nullptr in
   ///    which case the default
   ///    context will be used.
-  /// @param[in] options
+  /// \param[in] options
   ///    This object holds the options used to control when to stop, whether to
   ///    execute commands,
   ///    etc.
-  /// @param[out] result
+  /// \param[out] result
   ///    This is marked as succeeding with no output if all commands execute
   ///    safely,
   ///    and failed with some explanation if we aborted executing the commands
@@ -280,17 +280,17 @@ public:
   //------------------------------------------------------------------
   /// Execute a list of commands from a file.
   ///
-  /// @param[in] file
+  /// \param[in] file
   ///    The file from which to read in commands.
-  /// @param[in,out] context
+  /// \param[in,out] context
   ///    The execution context in which to run the commands. Can be nullptr in
   ///    which case the default
   ///    context will be used.
-  /// @param[in] options
+  /// \param[in] options
   ///    This object holds the options used to control when to stop, whether to
   ///    execute commands,
   ///    etc.
-  /// @param[out] result
+  /// \param[out] result
   ///    This is marked as succeeding with no output if all commands execute
   ///    safely,
   ///    and failed with some explanation if we aborted executing the commands
@@ -482,18 +482,18 @@ public:
 
   //------------------------------------------------------------------
   /// Sets the exit code for the quit command.
-  /// @param[in] exit_code
+  /// \param[in] exit_code
   ///     The exit code that the driver should return on exit.
-  /// @return True if the exit code was successfully set; false if the
+  /// \return True if the exit code was successfully set; false if the
   ///         interpreter doesn't allow custom exit codes.
-  /// @see AllowExitCodeOnQuit
+  /// \see AllowExitCodeOnQuit
   //------------------------------------------------------------------
   LLVM_NODISCARD bool SetQuitExitCode(int exit_code);
 
   //------------------------------------------------------------------
   /// Returns the exit code that the user has specified when running the
   /// 'quit' command.
-  /// @param[out] exited
+  /// \param[out] exited
   ///     Set to true if the user has called quit with a custom exit code.
   //------------------------------------------------------------------
   int GetQuitExitCode(bool &exited) const;
diff --git a/lldb/include/lldb/Interpreter/CommandObject.h b/lldb/include/lldb/Interpreter/CommandObject.h
index 0bb39c6bb9b..32f4dee985e 100644
--- a/lldb/include/lldb/Interpreter/CommandObject.h
+++ b/lldb/include/lldb/Interpreter/CommandObject.h
@@ -226,14 +226,14 @@ public:
   /// option. Don't override this method, override HandleArgumentCompletion
   /// instead unless you have special reasons.
   ///
-  /// @param[in/out] request
+  /// \param[in/out] request
   ///    The completion request that needs to be answered.
   ///
   /// FIXME: This is the wrong return value, since we also need to make a
   /// distinction between
   /// total number of matches, and the window the user wants returned.
   ///
-  /// @return
+  /// \return
   ///     \btrue if we were in an option, \bfalse otherwise.
   //------------------------------------------------------------------
   virtual int HandleCompletion(CompletionRequest &request);
@@ -246,14 +246,14 @@ public:
   /// We've constructed the map of options and their arguments as well if that
   /// is helpful for the completion.
   ///
-  /// @param[in/out] request
+  /// \param[in/out] request
   ///    The completion request that needs to be answered.
   ///
   /// FIXME: This is the wrong return value, since we also need to make a
   /// distinction between
   /// total number of matches, and the window the user wants returned.
   ///
-  /// @return
+  /// \return
   ///     The number of completions.
   //------------------------------------------------------------------
   virtual int
@@ -271,7 +271,7 @@ public:
   //------------------------------------------------------------------
   /// The flags accessor.
   ///
-  /// @return
+  /// \return
   ///     A reference to the Flags member variable.
   //------------------------------------------------------------------
   Flags &GetFlags() { return m_flags; }
@@ -279,7 +279,7 @@ public:
   //------------------------------------------------------------------
   /// The flags const accessor.
   ///
-  /// @return
+  /// \return
   ///     A const reference to the Flags member variable.
   //------------------------------------------------------------------
   const Flags &GetFlags() const { return m_flags; }
@@ -287,10 +287,10 @@ public:
   //------------------------------------------------------------------
   /// Get the command that appropriate for a "repeat" of the current command.
   ///
-  /// @param[in] current_command_line
+  /// \param[in] current_command_line
   ///    The complete current command line.
   ///
-  /// @return
+  /// \return
   ///     nullptr if there is no special repeat command - it will use the
   ///     current command line.
   ///     Otherwise a pointer to the command to be repeated.
@@ -371,11 +371,11 @@ protected:
   /// Check the command to make sure anything required by this
   /// command is available.
   ///
-  /// @param[out] result
+  /// \param[out] result
   ///     A command result object, if it is not okay to run the command
   ///     this will be filled in with a suitable error.
   ///
-  /// @return
+  /// \return
   ///     \b true if it is okay to run this command, \b false otherwise.
   //------------------------------------------------------------------
   bool CheckRequirements(CommandReturnObject &result);
diff --git a/lldb/include/lldb/Interpreter/OptionValueBoolean.h b/lldb/include/lldb/Interpreter/OptionValueBoolean.h
index 5e3dd34ee42..46c523c5536 100644
--- a/lldb/include/lldb/Interpreter/OptionValueBoolean.h
+++ b/lldb/include/lldb/Interpreter/OptionValueBoolean.h
@@ -57,13 +57,13 @@ public:
   ///
   /// This allows code to check a OptionValueBoolean in conditions.
   ///
-  /// @code
+  /// \code
   /// OptionValueBoolean bool_value(...);
   /// if (bool_value)
   /// { ...
-  /// @endcode
+  /// \endcode
   ///
-  /// @return
+  /// \return
   ///     /b True this object contains a valid namespace decl, \b
   ///     false otherwise.
   //------------------------------------------------------------------
diff --git a/lldb/include/lldb/Interpreter/Options.h b/lldb/include/lldb/Interpreter/Options.h
index f04a3956bcb..2d3358be679 100644
--- a/lldb/include/lldb/Interpreter/Options.h
+++ b/lldb/include/lldb/Interpreter/Options.h
@@ -47,7 +47,7 @@ static inline bool isprint8(int ch) {
 }
 
 //----------------------------------------------------------------------
-/// @class Options Options.h "lldb/Interpreter/Options.h"
+/// \class Options Options.h "lldb/Interpreter/Options.h"
 /// A command line option parsing protocol class.
 ///
 /// Options is designed to be subclassed to contain all needed options for a
@@ -76,8 +76,8 @@ public:
   //------------------------------------------------------------------
   /// Get the option definitions to use when parsing Args options.
   ///
-  /// @see Args::ParseOptions (Options&)
-  /// @see man getopt_long_only
+  /// \see Args::ParseOptions (Options&)
+  /// \see man getopt_long_only
   //------------------------------------------------------------------
   Option *GetLongOptions();
 
@@ -149,21 +149,21 @@ public:
   //------------------------------------------------------------------
   /// Set the value of an option.
   ///
-  /// @param[in] option_idx
+  /// \param[in] option_idx
   ///     The index into the "struct option" array that was returned
   ///     by Options::GetLongOptions().
   ///
-  /// @param[in] option_arg
+  /// \param[in] option_arg
   ///     The argument value for the option that the user entered, or
   ///     nullptr if there is no argument for the current option.
   ///
-  /// @param[in] execution_context
+  /// \param[in] execution_context
   ///     The execution context to use for evaluating the option.
   ///     May be nullptr if the option is to be evaluated outside any
   ///     particular context.
   ///
-  /// @see Args::ParseOptions (Options&)
-  /// @see man getopt_long_only
+  /// \see Args::ParseOptions (Options&)
+  /// \see man getopt_long_only
   //------------------------------------------------------------------
   virtual Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg,
                                 ExecutionContext *execution_context) = 0;
@@ -172,17 +172,17 @@ public:
   /// Handles the generic bits of figuring out whether we are in an option,
   /// and if so completing it.
   ///
-  /// @param[in/out] request
+  /// \param[in/out] request
   ///    The completion request that we need to act upon.
   ///
-  /// @param[in] interpreter
+  /// \param[in] interpreter
   ///     The interpreter that's doing the completing.
   ///
   /// FIXME: This is the wrong return value, since we also need to
   /// make a distinction between total number of matches, and the window the
   /// user wants returned.
   ///
-  /// @return
+  /// \return
   ///     \btrue if we were in an option, \bfalse otherwise.
   //------------------------------------------------------------------
   bool HandleOptionCompletion(lldb_private::CompletionRequest &request,
@@ -193,17 +193,17 @@ public:
   /// Handles the generic bits of figuring out whether we are in an option,
   /// and if so completing it.
   ///
-  /// @param[in/out] request
+  /// \param[in/out] request
   ///    The completion request that we need to act upon.
   ///
-  /// @param[in] interpreter
+  /// \param[in] interpreter
   ///    The command interpreter doing the completion.
   ///
   /// FIXME: This is the wrong return value, since we also need to
   /// make a distinction between total number of matches, and the window the
   /// user wants returned.
   ///
-  /// @return
+  /// \return
   ///     \btrue if we were in an option, \bfalse otherwise.
   //------------------------------------------------------------------
   virtual bool
@@ -289,7 +289,7 @@ public:
   /// Append all options from \a group using the exact same option groups that
   /// each option is defined with.
   ///
-  /// @param[in] group
+  /// \param[in] group
   ///     A group of options to take option values from and copy their
   ///     definitions into this class.
   //----------------------------------------------------------------------
@@ -302,18 +302,18 @@ public:
   /// "src_mask" set. After the option definition is copied into the options
   /// definitions in this class, set the usage_mask to "dst_mask".
   ///
-  /// @param[in] group
+  /// \param[in] group
   ///     A group of options to take option values from and copy their
   ///     definitions into this class.
   ///
-  /// @param[in] src_mask
+  /// \param[in] src_mask
   ///     When copying options from \a group, you might only want some of
   ///     the options to be appended to this group. This mask allows you
   ///     to control which options from \a group get added. It also allows
   ///     you to specify the same options from \a group multiple times
   ///     for different option sets.
   ///
-  /// @param[in] dst_mask
+  /// \param[in] dst_mask
   ///     Set the usage mask for any copied options to \a dst_mask after
   ///     copying the option definition.
   //----------------------------------------------------------------------