diff options
author | Adrian Prantl <aprantl@apple.com> | 2019-03-11 17:09:29 +0000 |
---|---|---|
committer | Adrian Prantl <aprantl@apple.com> | 2019-03-11 17:09:29 +0000 |
commit | f05b42e960a9badf37e17d896d5764ef9ffce8f2 (patch) | |
tree | 10eee8db975f1714b0474645422a520d47791813 /lldb/include/lldb/Expression/ExpressionParser.h | |
parent | 5ccb339107b40acb7f39743e2b21ef73a6406915 (diff) | |
download | bcm5719-llvm-f05b42e960a9badf37e17d896d5764ef9ffce8f2.tar.gz bcm5719-llvm-f05b42e960a9badf37e17d896d5764ef9ffce8f2.zip |
Bring Doxygen comment syntax in sync with LLVM coding style.
This changes '@' prefix to '\'.
llvm-svn: 355841
Diffstat (limited to 'lldb/include/lldb/Expression/ExpressionParser.h')
-rw-r--r-- | lldb/include/lldb/Expression/ExpressionParser.h | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/lldb/include/lldb/Expression/ExpressionParser.h b/lldb/include/lldb/Expression/ExpressionParser.h index 004a4e2bc04..37dddf60539 100644 --- a/lldb/include/lldb/Expression/ExpressionParser.h +++ b/lldb/include/lldb/Expression/ExpressionParser.h @@ -19,7 +19,7 @@ namespace lldb_private { class IRExecutionUnit; //---------------------------------------------------------------------- -/// @class ExpressionParser ExpressionParser.h +/// \class ExpressionParser ExpressionParser.h /// "lldb/Expression/ExpressionParser.h" Encapsulates an instance of a /// compiler that can parse expressions. /// @@ -32,12 +32,12 @@ public: /// /// Initializes class variables. /// - /// @param[in] exe_scope, + /// \param[in] exe_scope, /// If non-NULL, an execution context scope that can help to /// correctly create an expression with a valid process for /// optional tuning Objective-C runtime support. Can be NULL. /// - /// @param[in] expr + /// \param[in] expr /// The expression to be parsed. //------------------------------------------------------------------ ExpressionParser(ExecutionContextScope *exe_scope, Expression &expr, @@ -53,23 +53,23 @@ public: /// Attempts to find possible command line completions for the given /// expression. /// - /// @param[out] request + /// \param[out] request /// The completion request to fill out. The completion should be a string /// that would complete the current token at the cursor position. /// Note that the string in the list replaces the current token /// in the command line. /// - /// @param[in] line + /// \param[in] line /// The line with the completion cursor inside the expression as a string. /// The first line in the expression has the number 0. /// - /// @param[in] pos + /// \param[in] pos /// The character position in the line with the completion cursor. /// If the value is 0, then the cursor is on top of the first character /// in the line (i.e. the user has requested completion from the start of /// the expression). /// - /// @param[in] typed_pos + /// \param[in] typed_pos /// The cursor position in the line as typed by the user. If the user /// expression has not been transformed in some form (e.g. wrapping it /// in a function body for C languages), then this is equal to the @@ -77,7 +77,7 @@ public: /// 'pos' (e.g. a value of 0 means the cursor is at start of the /// expression). /// - /// @return + /// \return /// True if we added any completion results to the output; /// false otherwise. //------------------------------------------------------------------ @@ -88,10 +88,10 @@ public: /// Parse a single expression and convert it to IR using Clang. Don't wrap /// the expression in anything at all. /// - /// @param[in] diagnostic_manager + /// \param[in] diagnostic_manager /// The diagnostic manager in which to store the errors and warnings. /// - /// @return + /// \return /// The number of errors encountered during parsing. 0 means /// success. //------------------------------------------------------------------ @@ -102,10 +102,10 @@ public: /// expression. If successful, the rewritten expression is stored in the /// diagnostic_manager, get it out with GetFixedExpression. /// - /// @param[in] diagnostic_manager + /// \param[in] diagnostic_manager /// The diagnostic manager containing fixit's to apply. /// - /// @return + /// \return /// \b true if the rewrite was successful, \b false otherwise. //------------------------------------------------------------------ virtual bool RewriteExpression(DiagnosticManager &diagnostic_manager) { @@ -116,31 +116,31 @@ public: /// Ready an already-parsed expression for execution, possibly evaluating it /// statically. /// - /// @param[out] func_addr + /// \param[out] func_addr /// The address to which the function has been written. /// - /// @param[out] func_end + /// \param[out] func_end /// The end of the function's allocated memory region. (func_addr /// and func_end do not delimit an allocated region; the allocated /// region may begin before func_addr.) /// - /// @param[in] execution_unit_sp + /// \param[in] execution_unit_sp /// After parsing, ownership of the execution unit for /// for the expression is handed to this shared pointer. /// - /// @param[in] exe_ctx + /// \param[in] exe_ctx /// The execution context to write the function into. /// - /// @param[out] can_interpret + /// \param[out] can_interpret /// Set to true if the expression could be interpreted statically; /// untouched otherwise. /// - /// @param[in] execution_policy + /// \param[in] execution_policy /// Determines whether the expression must be JIT-compiled, must be /// evaluated statically, or whether this decision may be made /// opportunistically. /// - /// @return + /// \return /// An error code indicating the success or failure of the operation. /// Test with Success(). //------------------------------------------------------------------ |