Improve documentation of the lexer generation

Signed-off-by: Alex Lüpges <[email protected]>
MontiCore · Nov 27, 2024 · dfcfa23 · dfcfa23
1 parent 23f18ed
commit dfcfa23
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/monticore-generator/src/main/java/de/monticore/codegen/parser/ParserGeneratorHelper.java b/monticore-generator/src/main/java/de/monticore/codegen/parser/ParserGeneratorHelper.java
@@ -156,7 +156,7 @@ public String getOrComputeLexSymbolName(String constName) {
   }
 
   /**
-   * Does not
+   * Side effect free.
    * @return the name for a lexsymbol that was used in an Antlr-File
    */
   public Optional<String> getCachedLexSymbolName(String constName) {

diff --git a/monticore-grammar/src/main/java/de/monticore/grammar/LexNamer.java b/monticore-grammar/src/main/java/de/monticore/grammar/LexNamer.java
@@ -120,6 +120,13 @@ public static String createSimpleGoodName(String x) {
 
   }
 
+  /**
+   * Computes a new name for the lexical production or returns the previously
+   * computed one.
+   *
+   * @deprecated Use {@link LexNamer#getComputedLexName(String)}
+   * or {@link LexNamer#getOrComputeLexName(MCGrammarSymbol, String)} instead
+   */
   @Deprecated
   public String getLexName(MCGrammarSymbol grammarSymbol, String sym) {
     return this.getOrComputeLexName(grammarSymbol, sym);