diff options
author | 2010-11-15 22:27:59 -0500 | |
---|---|---|
committer | 2010-11-15 22:27:59 -0500 | |
commit | 9309bf0090968be7b1c0fea82c361e32c7d51ad3 (patch) | |
tree | d145985bc9f36434ec762b9f67cd2a4e9a99cb5f /modules | |
parent | 9c600dbc20fd5e0b990d66e74d0b86e426638a0f (diff) | |
download | textadept-9309bf0090968be7b1c0fea82c361e32c7d51ad3.tar.gz textadept-9309bf0090968be7b1c0fea82c361e32c7d51ad3.zip |
LuaDoc cleanup.
Diffstat (limited to 'modules')
-rw-r--r-- | modules/lua/commands.lua | 2 | ||||
-rw-r--r-- | modules/textadept/keys.lua | 4 | ||||
-rw-r--r-- | modules/textadept/mime_types.lua | 62 |
3 files changed, 7 insertions, 61 deletions
diff --git a/modules/lua/commands.lua b/modules/lua/commands.lua index 26fb08a1..e8c11773 100644 --- a/modules/lua/commands.lua +++ b/modules/lua/commands.lua @@ -24,7 +24,7 @@ module('_m.lua.commands', package.seeall) -- -- #### Syntax -- --- Fields are recognized as Lua line comments of the form ``-- * `field_name` ``. +-- Fields are recognized as Lua comments of the form ``-- * `field_name` ``. -- Functions are recognized as Lua functions of the form `function func(args)` -- or `function namespace:func(args)`. `.`-completion shows autocompletion for -- both fields and functions using the first function syntax. `:`-completion diff --git a/modules/textadept/keys.lua b/modules/textadept/keys.lua index baea06a8..67512b51 100644 --- a/modules/textadept/keys.lua +++ b/modules/textadept/keys.lua @@ -77,8 +77,8 @@ module('_m.textadept.keys', package.seeall) -- ## Key Command Precedence -- -- When searching for a key command to execute in the `keys` table, key commands --- in the current style have priority, followed by the ones in the current lexer, --- and finally the ones in the global table. +-- in the current style have priority, followed by the ones in the current +-- lexer, and finally the ones in the global table. -- -- ## Example -- 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. -- |