ScaCap / spring-auto-restdocs

Spring Auto REST Docs is an extension to Spring REST Docs
https://scacap.github.io/spring-auto-restdocs/
Apache License 2.0
310 stars 86 forks source link

Documentation extracting Doclet does not recognize overloaded methods. #434

Closed odrotbohm closed 9 months ago

odrotbohm commented 3 years ago

In a class:

class Foo {

  /**
   * First doc.
   */
  void someMethod(Integer integer) { … }

  /**
   * Second doc.
   */
  void someMethod(String string) { … }
}

Only the Javadoc for one of the two methods will be extracted as the generated JSON keys the method entries by name. It would be cool if it additionally considered the method parameters:

{ …,
  "on" : [ {
    "parameters" : "java.lang.Integer" // comma separated String for easy lookup
    "comment" : "…",
    …
  }, … ]
}