-
Notifications
You must be signed in to change notification settings - Fork 3
/
annotation.html
276 lines (159 loc) · 10.3 KB
/
annotation.html
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Annotations — EmmyLua for IntelliJ IDEA 1.3.2 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="@class class declaration annotation" href="annotations/class.html" />
<link rel="prev" title="via Zip file" href="installation/zip.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> EmmyLua for IntelliJ IDEA
</a>
<div class="version">
1.3.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="donate.html">Donate</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Annotations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="annotations/class.html">@class class declaration annotation</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/type.html">@type type annotation</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/alias.html">@alias 别名注解</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/param.html">@param parameter type annotation</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/return.html">@return function return type annotation</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/field.html">@field field annotation</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/generic.html">@generic generic annotation</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/vararg.html">@vararg 不定参数注解</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/language.html">@language language injection</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/array.html">array type</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/dict.html">table type</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/fun.html">function types</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/string_literal_type.html">字面量类型</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/see.html">@see references</a></li>
<li class="toctree-l2"><a class="reference internal" href="annotations/example.html">Full examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="template.html">Live Templates</a></li>
<li class="toctree-l1"><a class="reference internal" href="postfix.html">Postfix Completion</a></li>
<li class="toctree-l1"><a class="reference internal" href="run.html">Run And Debug</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelogs.html">Changelogs</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">EmmyLua for IntelliJ IDEA</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Annotations</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="annotations">
<h1>Annotations<a class="headerlink" href="#annotations" title="Permalink to this headline">¶</a></h1>
<p>EmmyLua use <code class="docutils literal notranslate"><span class="pre">annotation</span></code> to help IDE improve code completions and other functionality.</p>
<div class="admonition attention">
<p class="first admonition-title">Attention</p>
<p class="last">These features just help IDE to improve code completions and other functionality. It’s unrelated to Lua’s actual exectuion, since they’re just comments</p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="annotations/class.html">@class class declaration annotation</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/type.html">@type type annotation</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/alias.html">@alias 别名注解</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/param.html">@param parameter type annotation</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/return.html">@return function return type annotation</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/field.html">@field field annotation</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/generic.html">@generic generic annotation</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/vararg.html">@vararg 不定参数注解</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/language.html">@language language injection</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/array.html">array type</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/dict.html">table type</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/fun.html">function types</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/string_literal_type.html">字面量类型</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/see.html">@see references</a></li>
<li class="toctree-l1"><a class="reference internal" href="annotations/example.html">Full examples</a></li>
</ul>
</div>
</div>
</div>
<div class="articleComments">
<a href="https://github.com/tangzx/IntelliJ-EmmyLua"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a>
<script>
var idcomments_acct = 'b9a955b569ded5e921e4c18fb4c0536d';
var idcomments_post_id = 'annotation';
var idcomments_post_url;
</script>
<span id="IDCommentsPostTitle" style="display:none"></span>
<script type='text/javascript' src='https://www.intensedebate.com/js/genericCommentWrapperV2.js'></script>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="annotations/class.html" class="btn btn-neutral float-right" title="@class class declaration annotation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="installation/zip.html" class="btn btn-neutral float-left" title="via Zip file" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, tangzx([email protected])
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "https://hm.baidu.com/hm.js?0c7a09367003982fd38b8c6625cd3db5";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
</script>
</body>
</html>