From c2e7530edb3b9a380fbf3d21a0ef1a2530db65a1 Mon Sep 17 00:00:00 2001 From: Ben Culkin Date: Mon, 13 Apr 2020 18:35:26 -0400 Subject: Add some javadoc Add some javadoc comments --- src/main/java/tlIItools/Effect.java | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'src/main/java/tlIItools/Effect.java') 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 errs) { Effect efct = new Effect(); -- cgit v1.2.3