From d38324c3eb6e61357b101f5bb94c60ba15d891d3 Mon Sep 17 00:00:00 2001 From: aleigh Date: Tue, 31 May 2022 09:46:13 -0700 Subject: [PATCH] lc-evelyn-svc: Docs --- .../src/main/java/lc/evelyn/svc/EvelynService.java | 7 +++++++ .../src/main/java/lc/evelyn/svc/PastebinThread.java | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/lc-evelyn-svc/src/main/java/lc/evelyn/svc/EvelynService.java b/lc-evelyn-svc/src/main/java/lc/evelyn/svc/EvelynService.java index 71f3a5c35..a3464a800 100644 --- a/lc-evelyn-svc/src/main/java/lc/evelyn/svc/EvelynService.java +++ b/lc-evelyn-svc/src/main/java/lc/evelyn/svc/EvelynService.java @@ -7,6 +7,13 @@ import org.pircbotx.PircBotX; import org.pircbotx.hooks.ListenerAdapter; import org.pircbotx.hooks.types.GenericMessageEvent; +/** + * Evelyn is a digital assist in the guise of an IRC bot. It is programmed to inhabit the #leighco + * channel on the LEIGH&CO IRC network. + * + * @author Alex Leigh + * @since 1.0 + */ public class EvelynService extends ListenerAdapter { private static final MechaLogger logger = MechaLoggerFactory.getLogger(EvelynService.class); diff --git a/lc-evelyn-svc/src/main/java/lc/evelyn/svc/PastebinThread.java b/lc-evelyn-svc/src/main/java/lc/evelyn/svc/PastebinThread.java index fc7bf5699..1aa976f8e 100644 --- a/lc-evelyn-svc/src/main/java/lc/evelyn/svc/PastebinThread.java +++ b/lc-evelyn-svc/src/main/java/lc/evelyn/svc/PastebinThread.java @@ -11,6 +11,13 @@ import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; +/** + * This class implements a {@link Runnable} which monitors pastebin for new pastes. If one is detected + * then an announcement is sent to the #leighco IRC channel. + * + * @author Alex Leigh + * @since 1.0 + */ public class PastebinThread implements Runnable { private static final MechaLogger logger = MechaLoggerFactory.getLogger(PastebinThread.class); private final ComboPooledDataSource cpds; -- GitLab