Skip to content

Smarter processing of javadoc comments into OpenAPI documentation#761

Merged
graemerocher merged 3 commits intomicronaut-projects:masterfrom
altro3:javadoc_parser
Jul 11, 2022
Merged

Smarter processing of javadoc comments into OpenAPI documentation#761
graemerocher merged 3 commits intomicronaut-projects:masterfrom
altro3:javadoc_parser

Conversation

@altro3
Copy link
Collaborator

@altro3 altro3 commented Jul 9, 2022

  • Refactor JavadocParser.

  • Add support summary and description blocks in method javadoc.

  • Add support html tags which will be convert to markdown

  • Add support Operation internal parameters field.

  • Fix problem with set style for parameter

  • Add read class level javadoc (need to records, kotlin data classes and enums)

Fixes #265

@graemerocher
Copy link
Contributor

Wow this is pretty nice 🤩

Could you resolve the conflicts?

@graemerocher graemerocher changed the title Refactor JavadocParser and more Smarter processing of javadoc comments into OpenAPI documentation Jul 11, 2022
@graemerocher graemerocher added the type: enhancement New feature or request label Jul 11, 2022
@altro3
Copy link
Collaborator Author

altro3 commented Jul 11, 2022

@graemerocher but for full support need these changes: micronaut-projects/micronaut-core#7662

I hope you include this pull request in the 3.6.0 release.

altro3 added 2 commits July 11, 2022 16:15
… method javadoc. Add support html tags which will be convert to markdown.

Add support Operation internal parameters field. Fix problem with set style for parameter

Add read class level javadoc (need to records, kotlin data classes and enums)

Fixes #265
@altro3
Copy link
Collaborator Author

altro3 commented Jul 11, 2022

@graemerocher conflicts resolved :-)

/**
* Some util methods.
*/
public class Utils {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few small suggestions:

  • add @since tag please. I guess this will go in a 4.4.0 version of this module.
  • this class should be final.
  • it should have a private empty default constructor

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@graemerocher graemerocher merged commit 29fb37e into micronaut-projects:master Jul 11, 2022
@graemerocher
Copy link
Contributor

Thanks for the contribution!

Are these all your changes and can we do a 4.4.0 release? Thanks for all your work on this, it makes a big difference to the community!

@altro3
Copy link
Collaborator Author

altro3 commented Jul 11, 2022

@graemerocher You are welcome! :-) Yes, I think this is more than enough for the release. I will be able to make the following changes only over the weekend, but this will not be included in the next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Infer Operation summary and description attributes from Javadoc

3 participants