Support Deprecated methods

Author: rbygrave

src/main/java/io/dinject/javalin/generator/MethodReader.java

@@ -88,10 +88,15 @@ public void addMeta(ProcessingContext ctx) {
       }
 
       Operation operation = new Operation();
-      //operation.setDeprecated();
       //operation.setOperationId();
       operation.setSummary(javadoc.getSummary());
       operation.setDescription(javadoc.getDescription());
+      
+      if (javadoc.isDeprecated()) {
+        operation.setDeprecated(true);
+      } else if (element.getAnnotation(Deprecated.class) != null) {
+        operation.setDeprecated(true);
+      }
 
       switch (webMethod) {
         case GET: pathItem.setGet(operation); break;

src/main/java/io/dinject/javalin/generator/Processor.java

@@ -82,6 +82,9 @@ private void readOpenApiDefinition(RoundEnvironment round) {
 
       OpenAPIDefinition openApi = element.getAnnotation(OpenAPIDefinition.class);
       io.swagger.v3.oas.annotations.info.Info info = openApi.info();
+
+      logDebug("reading OpenAPIDefinition " + openApi + " info:" + info);
+
       if (!info.title().isEmpty()) {
         info1.setTitle(info.title());
       }

src/main/java/io/dinject/javalin/generator/javadoc/Javadoc.java

@@ -19,25 +19,29 @@ public class Javadoc {
 
   private final String returnDescription;
 
+  private final boolean deprecated;
+
   /**
    * Parse and return the Javadoc.
    */
   public static Javadoc parse(String content) {
     return new JavadocParser().parse(content);
   }
 
-  Javadoc(String summary, String description, Map<String, String> params, String returnDescription) {
+  Javadoc(String summary, String description, Map<String, String> params, String returnDescription, boolean deprecated) {
     this.summary = summary;
     this.description = description;
     this.params = params;
     this.returnDescription = returnDescription;
+    this.deprecated = deprecated;
   }
 
   private Javadoc() {
     this.summary = "";
     this.description = "";
     this.returnDescription = "";
     this.params = Collections.emptyMap();
+    this.deprecated = false;
   }
 
   public String getSummary() {
@@ -55,4 +59,8 @@ public Map<String, String> getParams() {
   public String getReturnDescription() {
     return returnDescription;
   }
+
+  public boolean isDeprecated() {
+    return deprecated;
+  }
 }

src/main/java/io/dinject/javalin/generator/javadoc/JavadocParser.java

@@ -19,6 +19,7 @@ class JavadocParser {
   private static final int PARAM_DESC = 7;
   private static final int RETURN_DESC = 8;
   private static final int IGNORE = 9;
+  private static final String DEPRECATED = "deprecated";
 
   private int previousState = TEXT;
 
@@ -32,6 +33,8 @@ class JavadocParser {
 
   private Map<String, String> params = new LinkedHashMap<>();
 
+  private boolean deprecated;
+
   /**
    * Parse the javadoc.
    */
@@ -121,10 +124,13 @@ private void processParamName(char c) {
   }
 
   private void processDocletStart(char c) {
-    if (c == ' ') {
+    if (c == ' ' || c == '\n') {
       state = previousState;
       String docletName = currentDoclet.toString();
       if (IGNORED.contains(docletName)) {
+        if (DEPRECATED.equals(docletName)) {
+          deprecated = true;
+        }
         state = IGNORE;
       } else {
         if (docletName.equals("param")) {
@@ -154,7 +160,7 @@ private Javadoc splitMain(String mainText) {
       desc = mergeLines(mainText.substring(pos + 1).trim());
     }
 
-    return new Javadoc(summary, desc, params, returnDesc);
+    return new Javadoc(summary, desc, params, returnDesc, deprecated);
   }
 
   String mergeLines(String multiline) {

src/test/java/io/dinject/javalin/generator/javadoc/JavadocParserTest.java

@@ -4,6 +4,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
 public class JavadocParserTest {
@@ -83,10 +84,44 @@ public void parse_with_summaryAndDescription() {
 
     assertEquals("This is a description", doc.getSummary());
     assertEquals("With bold and some code", doc.getDescription());
+    assertFalse(doc.isDeprecated());
     assertTrue(doc.getParams().isEmpty());
     assertEquals("", doc.getReturnDescription());
   }
 
+  @Test
+  public void parse_with_deprecated() {
+
+    JavadocParser parser = new JavadocParser();
+
+    Javadoc doc = parser.parse(
+      "Summary. Description\n" +
+        "@deprecated\n");
+
+    assertEquals("Summary", doc.getSummary());
+    assertEquals("Description", doc.getDescription());
+    assertTrue(doc.isDeprecated());
+    assertTrue(doc.getParams().isEmpty());
+    assertEquals("", doc.getReturnDescription());
+  }
+
+
+  @Test
+  public void parse_with_deprecatedWithComment() {
+
+    JavadocParser parser = new JavadocParser();
+
+    Javadoc doc = parser.parse(
+      "Summary. Description\n" +
+        "@since 1.0\n" +
+        "@deprecated Migration to something else\n");
+
+    assertEquals("Summary", doc.getSummary());
+    assertEquals("Description", doc.getDescription());
+    assertTrue(doc.isDeprecated());
+    assertTrue(doc.getParams().isEmpty());
+    assertEquals("", doc.getReturnDescription());
+  }
   @Test
   public void parse_returnNoEOL() {