docs: cleanup

- brief should live at the top of each file
- fix indentation for some docs

1 files changed, 34 insertions, 33 deletions

diff --git a/lsp/msbuild_project_tools_server.lua b/lsp/msbuild_project_tools_server.lua
index 490cfd2b..bf2f2b4b 100644
--- a/lsp/msbuild_project_tools_server.lua
+++ b/lsp/msbuild_project_tools_server.lua
@@ -1,39 +1,40 @@
+---@brief
+---
+--- https://github.com/tintoy/msbuild-project-tools-server/
+---
+--- MSBuild Project Tools Server can be installed by following the README.MD on the above repository.
+---
+--- Example config:
+--- ```lua
+--- vim.lsp.config('msbuild_project_tools_server', {
+---   cmd = {'dotnet', '/path/to/server/MSBuildProjectTools.LanguageServer.Host.dll'}
+--- })
+--- ```
+---
+--- There's no builtin filetypes for msbuild files, would require some filetype aliases:
+---
+--- ```lua
+--- vim.filetype.add({
+---   extension = {
+---     props = 'msbuild',
+---     tasks = 'msbuild',
+---     targets = 'msbuild',
+---   },
+---   pattern = {
+---     [ [[.*\..*proj]] ] = 'msbuild',
+---   },
+--- })
+--- ```
+---
+--- Optionally tell treesitter to treat `msbuild` as `xml` so you can get syntax highlighting if you have the treesitter-xml-parser installed.
+---
+--- ```lua
+--- vim.treesitter.language.register('xml', { 'msbuild' })
+--- ```
+
 local host_dll_name = 'MSBuildProjectTools.LanguageServer.Host.dll'
 local util = require 'lspconfig.util'
 
----@brief
----
--- https://github.com/tintoy/msbuild-project-tools-server/
---
--- MSBuild Project Tools Server can be installed by following the README.MD on the above repository.
---
--- Example config:
--- ```lua
--- vim.lsp.config('msbuild_project_tools_server', {
---   cmd = {'dotnet', '/path/to/server/MSBuildProjectTools.LanguageServer.Host.dll'}
--- })
--- ```
---
--- There's no builtin filetypes for msbuild files, would require some filetype aliases:
---
--- ```lua
--- vim.filetype.add({
---   extension = {
---     props = 'msbuild',
---     tasks = 'msbuild',
---     targets = 'msbuild',
---   },
---   pattern = {
---     [ [[.*\..*proj]] ] = 'msbuild',
---   },
--- })
--- ```
---
--- Optionally tell treesitter to treat `msbuild` as `xml` so you can get syntax highlighting if you have the treesitter-xml-parser installed.
---
--- ```lua
--- vim.treesitter.language.register('xml', { 'msbuild' })
--- ```
 return {
   filetypes = { 'msbuild' },
   root_dir = function(bufnr, on_dir)