blob: 6f34dcba452679efc96e485e3f4636ca8855efd1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
-- Copyright 2007-2010 Mitchell mitchell<att>caladbolg.net. See LICENSE.
-- This is a DUMMY FILE used for making LuaDoc for built-in functions in the
-- global _m table.
---
-- A table of loaded modules.
module('_m')
-- Markdown:
-- ## Overview
--
-- Note that while language-specific modules can only be used by files of that
-- language, they persist in Textadept's Lua state. Because of this, it is not
-- recommended to set global functions or variables and depend on them, as they
-- may be inadvertantly overwritten. Keep these inside the module.
--
-- ## Structure
--
-- Each module should have an `init.lua` that `require`s all submodules it
-- needs. For an example, see `modules/textadept/init.lua`.
--
-- ## Recommended Features for Language-Specific Modules
--
-- #### Snippets
--
-- [Snippets](../modules/_m.textadept.snippets.html) for common code constructs.
--
-- #### Commands
--
-- ##### Run
--
-- If the code can be run by an interpreter or other executable, create a [run
-- command](../modules/_m.textadept.run.html#run_command) for it as well as an
-- [error format](../modules/_m.textadept.run.html#error_detail) for the ability
-- to jump to the position in a file where the error occured.
--
-- For example:
--
-- _m.textadept.run.run_command.lua = 'lua %(filename)'
--
-- ##### Compile
--
-- If the code can be compiled by an executable, create a [compile
-- command](../modules/_m.textadept.run.html#compile_command) for it.
--
-- For example:
--
-- _m.textadept.run.compile_command.lua = 'luac %(filename)'
--
-- ##### Block Comment
--
-- Create a [comment
-- prefix](../modules/_m.textadept.editing.html#comment_string) for it so code
-- can be easily commented and uncommented.
--
-- For example:
--
-- _m.textadept.editing.comment_string.lua = '--'
--
-- #### Buffer Properties
--
-- Add a `set_buffer_properties` function with default buffer properties for
-- code like tab and indentation settings.
--
-- For example:
--
-- function set_buffer_properties()
-- local buffer = buffer
-- buffer.use_tabs = false
-- buffer.tab_width = 2
-- buffer.indent = 2
-- end
--
-- ## Modules and Key Commands
--
-- When assigning [key commands](../modules/_m.textadept.keys.html) to module
-- functions, do not forget to do so AFTER the function has been defined.
-- Typically key commands are placed at the end of files, like `init.lua` in
-- the `textadept` module.
---
-- This module contains no functions.
function no_functions() end no_functions = nil
|
