aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/mime_types.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2010-11-15 22:27:59 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2010-11-15 22:27:59 -0500
commit9309bf0090968be7b1c0fea82c361e32c7d51ad3 (patch)
treed145985bc9f36434ec762b9f67cd2a4e9a99cb5f /modules/textadept/mime_types.lua
parent9c600dbc20fd5e0b990d66e74d0b86e426638a0f (diff)
downloadtextadept-9309bf0090968be7b1c0fea82c361e32c7d51ad3.tar.gz
textadept-9309bf0090968be7b1c0fea82c361e32c7d51ad3.zip
LuaDoc cleanup.
Diffstat (limited to 'modules/textadept/mime_types.lua')
-rw-r--r--modules/textadept/mime_types.lua62
1 files changed, 4 insertions, 58 deletions
diff --git a/modules/textadept/mime_types.lua b/modules/textadept/mime_types.lua
index 372a305a..f066e46b 100644
--- a/modules/textadept/mime_types.lua
+++ b/modules/textadept/mime_types.lua
@@ -52,64 +52,10 @@ module('_m.textadept.mime_types', package.seeall)
-- This module adds an extra function to `buffer`:
--
-- * **buffer:set\_lexer** (language)<br />
--- Replacement for [`buffer:set_lexer_language()`][buffer_set_lexer_language].<br />
--- Sets a buffer._lexer field so it can be restored without querying the
--- mime-types tables. Also if the user manually sets the lexer, it should be
--- restored.<br />
--- Loads the language-specific module if it exists.
--- - lang: The string language to set.
---
--- [buffer_set_lexer_language]: buffer.html#buffer:set_lexer_language
-
--- Markdown:
--- ## Overview
---
--- Files can be recognized and associated with programming language lexers in
--- three ways:
---
--- * By file extension.
--- * By keywords in the file's shebang (`#!/path/to/exe`) line.
--- * By a pattern that matches the file's first line.
---
--- If a lexer is not associated with a file you open, first make sure the lexer
--- exists in `lexers/`. If it does not, you will need to write one. Consult the
--- [lexer][lexer] module for a tutorial.
---
--- [lexer]: ../modules/lexer.html
---
--- ## Configuration Files
---
--- Built-in mime-types are located in `core/ext/mime_types.conf`. You can
--- override or add to them in your `~/.textadept/mime_types.conf`.
---
--- #### Detection by File Extension
---
--- file_ext lexer
---
--- Note: `file_ext` should not start with a `.` (period).
---
--- #### Detection by Shebang Keywords
---
--- #shebang_word lexer
---
--- Examples of `shebang_word`'s are `lua`, `ruby`, `python`.
---
--- #### Detection by Pattern
---
--- /pattern lexer
---
--- Only the last space, the one separating the pattern from the lexer, is
--- significant. No spaces in the pattern need to be escaped.
---
--- ## Extras
---
--- This module adds an extra function to `buffer`:
---
--- * **buffer:set\_lexer** (language)<br />
--- Replacement for [`buffer:set_lexer_language()`][buffer_set_lexer_language].<br />
--- Sets a buffer._lexer field so it can be restored without querying the
--- mime-types tables. Also if the user manually sets the lexer, it should be
--- restored.<br />
+-- Replacement for [`buffer:set_lexer_language()`][buffer_set_lexer_language].
+-- <br /> Sets a buffer._lexer field so it can be restored without querying
+-- the mime-types tables. Also if the user manually sets the lexer, it should
+-- be restored.<br />
-- Loads the language-specific module if it exists.
-- - lang: The string language to set.
--