Add JavaDoc and some minor fixes.

jplag · Aug 22, 2023 · e8fbd1c · e8fbd1c
1 parent 71a6a18
commit e8fbd1c
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 5 deletions.
diff --git a/languages/llvmir/src/main/java/de/jplag/llvmir/LLVMIRLanguage.java b/languages/llvmir/src/main/java/de/jplag/llvmir/LLVMIRLanguage.java
@@ -6,7 +6,7 @@
 import de.jplag.antlr.AbstractAntlrLanguage;
 
 /**
- * This represents the LLVMIR language as a language supported by JPlag.
+ * The entry point for the ANTLR parser based LLVM IR language module.
  */
 @MetaInfServices(Language.class)
 public class LLVMIRLanguage extends AbstractAntlrLanguage {

diff --git a/languages/llvmir/src/main/java/de/jplag/llvmir/LLVMIRListener.java b/languages/llvmir/src/main/java/de/jplag/llvmir/LLVMIRListener.java
@@ -115,8 +115,18 @@
 import de.jplag.antlr.AbstractAntlrListener;
 import de.jplag.antlr.TokenCollector;
 
+/**
+ * Extracts tokens from the ANTLR parse tree. The token abstraction includes nesting tokens for functions and basic
+ * blocks and separate tokens for different elements. These include binary and bitwise instructions, memory operations,
+ * terminator instructions, conversions, global variables, type definitions, constants, and others.
+ */
 public class LLVMIRListener extends AbstractAntlrListener {
 
+    /**
+     * New instance
+     * @param collector The token collector the token will be added to
+     * @param currentFile The currently processed file
+     */
     public LLVMIRListener(TokenCollector collector, File currentFile) {
         super(collector, currentFile);
 

diff --git a/languages/llvmir/src/main/java/de/jplag/llvmir/LLVMIRParserAdapter.java b/languages/llvmir/src/main/java/de/jplag/llvmir/LLVMIRParserAdapter.java
@@ -4,12 +4,16 @@
 
 import org.antlr.v4.runtime.*;
 
+import de.jplag.AbstractParser;
 import de.jplag.antlr.AbstractAntlrListener;
 import de.jplag.antlr.AbstractAntlrParserAdapter;
 import de.jplag.antlr.TokenCollector;
 import de.jplag.llvmir.grammar.LLVMIRLexer;
 import de.jplag.llvmir.grammar.LLVMIRParser;
 
+/**
+ * The adapter between {@link AbstractParser} and the ANTLR based parser of this language module.
+ */
 public class LLVMIRParserAdapter extends AbstractAntlrParserAdapter<LLVMIRParser> {
     @Override
     protected Lexer createLexer(CharStream input) {

diff --git a/languages/llvmir/src/main/java/de/jplag/llvmir/LLVMIRTokenType.java b/languages/llvmir/src/main/java/de/jplag/llvmir/LLVMIRTokenType.java
@@ -2,6 +2,9 @@
 
 import de.jplag.TokenType;
 
+/**
+ * LLVM IR token types extracted by this language module.
+ */
 public enum LLVMIRTokenType implements TokenType {
 
     FILENAME("FILENAME"),
@@ -85,11 +88,12 @@ public enum LLVMIRTokenType implements TokenType {
 
     private final String description;
 
-    public String getDescription() {
-        return description;
-    }
-
     LLVMIRTokenType(String description) {
         this.description = description;
     }
+
+    @Override
+    public String getDescription() {
+        return description;
+    }
 }