forked from processing/processing-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdoccomment.xml
More file actions
executable file
·59 lines (39 loc) · 1.09 KB
/
doccomment.xml
File metadata and controls
executable file
·59 lines (39 loc) · 1.09 KB
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
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
<name>/** */ (doc comment)</name>
<category>Structure</category>
<subcategory></subcategory>
<usage>Web & Application</usage>
<example>
<image></image>
<code><![CDATA[
/**
Draws two lines which divides the window
into four quadrants. First draws a horizontal
line and then the vertical line
*/
line(0, 50, 100, 50);
line(50, 0, 50, 100);
]]></code>
</example>
<description><![CDATA[
Explanatory notes embedded within the code and written to the "index.html" file created when the code is exported. Doc comments (documentation comments) are used for sharing a description of your sketch when the program is exported. Export the code by hitting the "Export" button on the Toolbar.
]]></description>
<syntax>
/**
<c>comment</c>
*/
</syntax>
<parameter>
<label>comment</label>
<description><![CDATA[any sequence of characters]]></description>
</parameter>
<returns></returns>
<related>
// (comment)
/* */ (multiline comment)
</related>
<availability>1.0</availability>
<type>Operator</type>
<partof>PDE</partof>
</root>