[clang-tools-extra] r305299 - [clangd] A comment for ClangdServer's constructor. NFC.

[Ilya Biryukov via cfe-commits]

Author: ibiryukov
Date: Tue Jun 13 11:02:27 2017
New Revision: 305299

URL: http://llvm.org/viewvc/llvm-project?rev=305299&view=rev
Log:
[clangd] A comment for ClangdServer's constructor. NFC.

Modified:
    clang-tools-extra/trunk/clangd/ClangdServer.h

Modified: clang-tools-extra/trunk/clangd/ClangdServer.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/ClangdServer.h?rev=305299&r1=305298&r2=305299&view=diff
==============================================================================
--- clang-tools-extra/trunk/clangd/ClangdServer.h (original)
+++ clang-tools-extra/trunk/clangd/ClangdServer.h Tue Jun 13 11:02:27 2017
@@ -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);