springdoc-openapi icon indicating copy to clipboard operation
springdoc-openapi copied to clipboard

The openapi interface generated by the javadoc plug-in is not a Chinese comment, but an English class name. I hope I can optimize whether comments can be used (for example, the first line of the comment is used as a name)

Open JavaLionLi opened this issue 1 year ago • 3 comments

Describe the bug

  • If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible:
  • A clear and concise description of what the bug is: the title of an issue is not enough

image image

Name is a class name, no comment is used. I want to set the name to comment.

To Reproduce Steps to reproduce the behavior:

  • What version of spring-boot you are using?
  • What modules and versions of springdoc-openapi are you using?
  • What is the actual and the expected result using OpenAPI Description (yml or json)?
  • Provide with a sample code (HelloController) or Test that reproduces the problem

Expected behavior

  • A clear and concise description of what you expected to happen.
  • What is the expected result using OpenAPI Description (yml or json)?

Screenshots If applicable, add screenshots to help explain your problem.

Additional context Add any other context about the problem here.

JavaLionLi avatar Jul 18 '24 09:07 JavaLionLi

You can refer to this implementation: RuoYi-Vue-Plus

Free-LZJ avatar Aug 11 '24 14:08 Free-LZJ

You can refer to this implementation: RuoYi-Vue-Plus

I am the author of RuoYi-Vue-Plus I hope the official will take care of this

JavaLionLi avatar Aug 12 '24 02:08 JavaLionLi

!!!没注意ID撞到大佬了

Free-LZJ avatar Aug 12 '24 03:08 Free-LZJ

This is not handled in springdoc-openapi code. If there any enhancement for the javadoc generation, feel free to report it to https://github.com/dnault/therapi-runtime-javadoc

bnasslahsen avatar Sep 22 '24 09:09 bnasslahsen