Skip to content

Commit 8c7ac55

Browse files
committed
Add dictionary documentation.
1 parent 81daedf commit 8c7ac55

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/main/java/org/byteskript/skript/lang/syntax/dictionary/DictionaryMember.java

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,26 @@
77
package org.byteskript.skript.lang.syntax.dictionary;
88

99
import mx.kenzie.foundation.MethodBuilder;
10+
import org.byteskript.skript.api.note.Documentation;
1011
import org.byteskript.skript.api.syntax.Member;
1112
import org.byteskript.skript.compiler.*;
1213
import org.byteskript.skript.compiler.structure.SectionMeta;
1314
import org.byteskript.skript.lang.element.StandardElements;
1415

16+
@Documentation(
17+
name = "Dictionary",
18+
description = """
19+
Tells the compiler about available resources in other files.
20+
Allows remote types and functions to be 'imported' to avoid using their fully-qualified names in code.
21+
""",
22+
examples = {
23+
"""
24+
dictionary:
25+
import type skript/otherscript/MyType
26+
import function "cool_func" from skript/otherscript
27+
"""
28+
}
29+
)
1530
public class DictionaryMember extends Member {
1631

1732
public DictionaryMember() {

0 commit comments

Comments
 (0)