diff options
| author | Ben Culkin <scorpress@gmail.com> | 2020-04-13 18:35:26 -0400 |
|---|---|---|
| committer | Ben Culkin <scorpress@gmail.com> | 2020-04-13 18:35:26 -0400 |
| commit | c2e7530edb3b9a380fbf3d21a0ef1a2530db65a1 (patch) | |
| tree | f690c7420a43f7f4ff6d947c3c4a2b99833ea6a1 /src/main/java/tlIItools/Effect.java | |
| parent | 751bfe82adf25a9ad2e2923fbb621f80f8e5ddc6 (diff) | |
Add some javadoc
Add some javadoc comments
Diffstat (limited to 'src/main/java/tlIItools/Effect.java')
| -rw-r--r-- | src/main/java/tlIItools/Effect.java | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/main/java/tlIItools/Effect.java b/src/main/java/tlIItools/Effect.java index 04383417..12e2765a 100644 --- a/src/main/java/tlIItools/Effect.java +++ b/src/main/java/tlIItools/Effect.java @@ -443,10 +443,25 @@ public class Effect { return true; } + /** + * Parse an effect. + * @param afx The affix the effect belongs to. + * @param scn The scanner to read from. + * @param scnSource The name of the scanner. + * @return An effect, read from the scanner. + */ public static Effect parseEffect(Affix afx, Scanner scn, String scnSource) { return parseEffect(afx, scn, scnSource, new ArrayList<>()); } + /** + * Parse an effect. + * @param afx The affix the effect belongs to. + * @param scn The scanner to read from. + * @param scnSource The name of the scanner. + * @param errs Repository for errors found while parsing. + * @return An effect, read from the scanner. + */ public static Effect parseEffect(Affix afx, Scanner scn, String scnSource, List<String> errs) { Effect efct = new Effect(); |
