diff options
Diffstat (limited to 'include/clang/Tooling/Execution.h')
| -rw-r--r-- | include/clang/Tooling/Execution.h | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/include/clang/Tooling/Execution.h b/include/clang/Tooling/Execution.h index a3036bdfc1..71c97f3db1 100644 --- a/include/clang/Tooling/Execution.h +++ b/include/clang/Tooling/Execution.h @@ -37,7 +37,7 @@ namespace clang { namespace tooling { -/// \brief An abstraction for the result of a tool execution. For example, the +/// An abstraction for the result of a tool execution. For example, the /// underlying result can be in-memory or on-disk. /// /// Results should be string key-value pairs. For example, a refactoring tool @@ -52,7 +52,7 @@ public: llvm::function_ref<void(StringRef Key, StringRef Value)> Callback) = 0; }; -/// \brief Stores the key-value results in memory. It maintains the lifetime of +/// Stores the key-value results in memory. It maintains the lifetime of /// the result. Clang tools using this class are expected to generate a small /// set of different results, or a large set of duplicated results. class InMemoryToolResults : public ToolResults { @@ -72,16 +72,16 @@ private: std::vector<std::pair<llvm::StringRef, llvm::StringRef>> KVResults; }; -/// \brief The context of an execution, including the information about +/// The context of an execution, including the information about /// compilation and results. class ExecutionContext { public: virtual ~ExecutionContext() {} - /// \brief Initializes a context. This does not take ownership of `Results`. + /// Initializes a context. This does not take ownership of `Results`. explicit ExecutionContext(ToolResults *Results) : Results(Results) {} - /// \brief Adds a KV pair to the result container of this execution. + /// Adds a KV pair to the result container of this execution. void reportResult(StringRef Key, StringRef Value); // Returns the source control system's revision number if applicable. @@ -99,7 +99,7 @@ private: ToolResults *Results; }; -/// \brief Interface for executing clang frontend actions. +/// Interface for executing clang frontend actions. /// /// This can be extended to support running tool actions in different /// execution mode, e.g. on a specific set of TUs or many TUs in parallel. @@ -112,54 +112,54 @@ class ToolExecutor { public: virtual ~ToolExecutor() {} - /// \brief Returns the name of a specific executor. + /// Returns the name of a specific executor. virtual StringRef getExecutorName() const = 0; - /// \brief Executes each action with a corresponding arguments adjuster. + /// Executes each action with a corresponding arguments adjuster. virtual llvm::Error execute(llvm::ArrayRef< std::pair<std::unique_ptr<FrontendActionFactory>, ArgumentsAdjuster>> Actions) = 0; - /// \brief Convenient functions for the above `execute`. + /// Convenient functions for the above `execute`. llvm::Error execute(std::unique_ptr<FrontendActionFactory> Action); /// Executes an action with an argument adjuster. llvm::Error execute(std::unique_ptr<FrontendActionFactory> Action, ArgumentsAdjuster Adjuster); - /// \brief Returns a reference to the execution context. + /// Returns a reference to the execution context. /// /// This should be passed to tool callbacks, and tool callbacks should report /// results via the returned context. virtual ExecutionContext *getExecutionContext() = 0; - /// \brief Returns a reference to the result container. + /// Returns a reference to the result container. /// /// NOTE: This should only be used after the execution finishes. Tool /// callbacks should report results via `ExecutionContext` instead. virtual ToolResults *getToolResults() = 0; - /// \brief Map a virtual file to be used while running the tool. + /// Map a virtual file to be used while running the tool. /// /// \param FilePath The path at which the content will be mapped. /// \param Content A buffer of the file's content. virtual void mapVirtualFile(StringRef FilePath, StringRef Content) = 0; }; -/// \brief Interface for factories that create specific executors. This is also +/// Interface for factories that create specific executors. This is also /// used as a plugin to be registered into ToolExecutorPluginRegistry. class ToolExecutorPlugin { public: virtual ~ToolExecutorPlugin() {} - /// \brief Create an `ToolExecutor`. + /// Create an `ToolExecutor`. /// /// `OptionsParser` can be consumed (e.g. moved) if the creation succeeds. virtual llvm::Expected<std::unique_ptr<ToolExecutor>> create(CommonOptionsParser &OptionsParser) = 0; }; -/// \brief This creates a ToolExecutor that is in the global registry based on +/// This creates a ToolExecutor that is in the global registry based on /// commandline arguments. /// /// This picks the right executor based on the `--executor` option. This parses |