Skip to content

Commit 0210666

Browse files
committed
update javadoc
1 parent 0ca3f3f commit 0210666

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

key.core/src/main/java/de/uka/ilkd/key/scripts/ScriptCommandAst.java

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,27 @@
1111
import org.jspecify.annotations.NullMarked;
1212
import org.jspecify.annotations.Nullable;
1313

14-
/**
15-
* This class represents is the AST of a proof script command.
16-
*
17-
* @param commandName the name of the command, e.g., "macro" for {@code macro auto;}
18-
* @param namedArgs a map of the given named arguments and values. If a named argument is not given,
19-
* the entry should be missing in the map. Null-values are not allowed.
20-
* @param positionalArgs the list of given positional arguments
21-
* @param commands a nullable block of proof script arguments (represents "higher-order proof
22-
* scripts")
23-
* @param location the location of this command for error reporting.
24-
* @author Alexander Weigl
25-
* @version 1 (14.03.25)
26-
*/
14+
/// This class represents is the AST of a proof script command.
15+
///
16+
/// It is an abstraction to the commands of following structure:
17+
///
18+
/// ```
19+
/// <commandName> key_1=value_1 ... key_m=value_m positionalArgs_1 ... positionalArgs_n {
20+
/// commands_0; ...; commands_k;
21+
/// }
22+
/// ```
23+
///
24+
///
25+
/// @param commandName the name of the command, e.g., "macro" for `macro auto;`
26+
/// @param namedArgs a map of the given named arguments and values.
27+
/// If a named argument is not given, the entry should be missing in the map. Null-values are not allowed.
28+
/// @param positionalArgs the list of given positional arguments
29+
/// @param commands a nullable block of proof script arguments (represents "higher-order proof
30+
/// scripts").
31+
/// If null, the block was omitted syntactically in contrast to an empty list.
32+
/// @param location the location of this command for error reporting.
33+
/// @author Alexander Weigl
34+
/// @version 1 (14.03.25)
2735
@NullMarked
2836
public record ScriptCommandAst(
2937
String commandName,

0 commit comments

Comments
 (0)