massive update, probably broken
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-clangd / README.md
index 7bc99f2542f3f5d5a9136142ee4eeb4e04ecbcdd..7bf2ef856b8a9d13cb75c1f542bd399de3d64e61 100644 (file)
@@ -21,25 +21,35 @@ This extension connects [coc.nvim][] to the [clangd][] language server.
 `coc-clangd` adds support for:
 
 - Switching between header and implementation file: `:CocCommand clangd.switchSourceHeader`
+  - You can open in split buffer by `:CocCommand clangd.switchSourceHeader vsplit`
 - File status monitor, shows on NeoVim statusline
 - Describe symbol under the cursor: `:CocCommand clangd.symbolInfo`
 - Completions that adjust text near the cursor (e.g. correcting `.` to `->`)
 
 ## Configurations
 
-- `clangd.enabled`: enable `coc-clangd`, default `true`
-- `clangd.arguments`: arguments for `clangd` server, default `[]`
-- `clangd.checkUpdates`: check for clangd language server updates on startup, default `false`
-- `clangd.disableDiagnostics`: disable diagnostics from clangd, default `false`
-- `clangd.disableSnippetCompletion`: disable completion snippet from clangd, default `false`
-- `clangd.fallbackFlags`: extra clang flags used to parse files when no compilation database is found., default `[]`
-- `clangd.path`: path to `clangd` executable, default `clangd`
-- `clangd.semanticHighlighting`: enable semantic highlighting, requires [jackguo380/vim-lsp-cxx-highlight](https://github.com/jackguo380/vim-lsp-cxx-highlight) to work, default `false`
+`:CocConfig` opens your global `coc-settings.json`, or `:CocLocalConfig` opens local configuration in your project `.vim/coc-settings.json`.
+
+| Configurations                  | Description                                                                                                                            | Default  |
+| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| clangd.enabled                  | enable `coc-clangd`                                                                                                                    | `true`   |
+| clangd.arguments                | arguments for `clangd` server                                                                                                          | `[]`     |
+| clangd.checkUpdates             | check for clangd language server updates on startup                                                                                    | `false`  |
+| clangd.disableCompletion        | disable completion source from clangd                                                                                                  | `false`  |
+| clangd.disableDiagnostics       | disable diagnostics from clangd                                                                                                        | `false`  |
+| clangd.disableSnippetCompletion | disable completion snippet from clangd                                                                                                 | `false`  |
+| clangd.compilationDatabasePath  | specifies the directory containing the compilation database                                                                            | `''`     |
+| clangd.fallbackFlags            | extra clang flags used to parse files when no compilation database is found                                                            | `[]`     |
+| clangd.path                     | path to `clangd` executable                                                                                                            | `clangd` |
+| clangd.semanticHighlighting     | enable semantic highlighting, requires [jackguo380/vim-lsp-cxx-highlight](https://github.com/jackguo380/vim-lsp-cxx-highlight) to work | `false`  |
+| clangd.serverCompletionRanking  | always rank compilation items on the server as you type                                                                                | `true`   |
 
 ## Commands
 
 - `clangd.switchSourceHeader`: switch between source/header files
 - `clangd.symbolInfo`: resolve symbol info under the cursor
+- `clangd.memoryUsage`: show memory usage
+- `clangd.ast`: show AST
 - `clangd.install`: install latest clangd release from GitHub
 - `clangd.update`: check for updates to clangd from GitHub
 
@@ -51,7 +61,7 @@ This is the [standard LLVM license](https://llvm.org/foundation/relicensing/).
 
 ---
 
-> This extension is created by [create-coc-extension](https://github.com/fannheyward/create-coc-extension)
+> This extension is built with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)
 
 [node.js]: https://nodejs.org/en/
 [clangd]: https://clangd.llvm.org/installation.html