docs: cleanup

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

1 files changed, 24 insertions, 23 deletions

diff --git a/lsp/ltex_plus.lua b/lsp/ltex_plus.lua
index 97a9cf90..e5444f97 100644
--- a/lsp/ltex_plus.lua
+++ b/lsp/ltex_plus.lua
@@ -1,3 +1,27 @@
+---@brief
+---
+--- https://github.com/ltex-plus/ltex-ls-plus
+---
+--- LTeX Language Server: LSP language server for LanguageTool 🔍✔️ with support for LaTeX 🎓, Markdown 📝, and others
+---
+--- To install, download the latest [release](https://github.com/ltex-plus/ltex-ls-plus) and ensure `ltex-ls-plus` is on your path.
+---
+--- This server accepts configuration via the `settings` key.
+---
+--- ```lua
+---   settings = {
+---     ltex = {
+---       language = "en-GB",
+---     },
+---   },
+--- ```
+---
+--- To support org files or R sweave, users can define a custom filetype autocommand (or use a plugin which defines these filetypes):
+---
+--- ```lua
+--- vim.cmd [[ autocmd BufRead,BufNewFile *.org set filetype=org ]]
+--- ```
+
 local language_id_mapping = {
   bib = 'bibtex',
   pandoc = 'markdown',
@@ -12,29 +36,6 @@ local function get_language_id(_, filetype)
   return language_id_mapping[filetype] or filetype
 end
 
----@brief
----
--- https://github.com/ltex-plus/ltex-ls-plus
---
--- LTeX Language Server: LSP language server for LanguageTool 🔍✔️ with support for LaTeX 🎓, Markdown 📝, and others
---
--- To install, download the latest [release](https://github.com/ltex-plus/ltex-ls-plus) and ensure `ltex-ls-plus` is on your path.
---
--- This server accepts configuration via the `settings` key.
---
--- ```lua
---   settings = {
---     ltex = {
---       language = "en-GB",
---     },
---   },
--- ```
---
--- To support org files or R sweave, users can define a custom filetype autocommand (or use a plugin which defines these filetypes):
---
--- ```lua
--- vim.cmd [[ autocmd BufRead,BufNewFile *.org set filetype=org ]]
--- ```
 return {
   cmd = { 'ltex-ls-plus' },
   filetypes = {