From 0bdafe5b63da626cbd5421b08c299b4dfeaaa39b Mon Sep 17 00:00:00 2001 From: Ilya Biryukov Date: Tue, 13 Jun 2017 16:02:27 +0000 Subject: [PATCH] [clangd] A comment for ClangdServer's constructor. NFC. llvm-svn: 305299 --- clang-tools-extra/clangd/ClangdServer.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/clang-tools-extra/clangd/ClangdServer.h b/clang-tools-extra/clangd/ClangdServer.h index d7d2d4185525..1845edd225a1 100644 --- a/clang-tools-extra/clangd/ClangdServer.h +++ b/clang-tools-extra/clangd/ClangdServer.h @@ -136,6 +136,15 @@ private: /// diagnostics for tracked files). class ClangdServer { public: + /// Creates a new ClangdServer. If \p RunSynchronously is false, no worker + /// thread will be created and all requests will be completed synchronously on + /// the calling thread (this is mostly used for tests). If \p RunSynchronously + /// is true, a worker thread will be created to parse files in the background + /// and provide diagnostics results via DiagConsumer.onDiagnosticsReady + /// callback. File accesses for each instance of parsing will be conducted via + /// a vfs::FileSystem provided by \p FSProvider. Results of code + /// completion/diagnostics also include a tag, that \p FSProvider returns + /// along with the vfs::FileSystem. ClangdServer(GlobalCompilationDatabase &CDB, DiagnosticsConsumer &DiagConsumer, FileSystemProvider &FSProvider, bool RunSynchronously);