maven-plugin-tools icon indicating copy to clipboard operation
maven-plugin-tools copied to clipboard
verified publisher icon apache

[MPLUGIN-426] add @Description annotation

Open bmarwell opened this issue 3 years ago • 5 comments

ITs missing, tests missing, draft.

bmarwell avatar Oct 16 '22 20:10 bmarwell

Looks ok to me

cstamas avatar Oct 17 '22 08:10 cstamas

commits added as a review build is failing on GH: does not seem related to this updates, but we'll need to fix because additional failure (like the rat failure I fixed) are not visible

hboutemy avatar Oct 18 '22 06:10 hboutemy

Should the new annotation contain a since field to be able to avoid the since javadoc tag ?

gnodet avatar Nov 15 '22 22:11 gnodet

Should the new annotation contain a since field to be able to avoid the since javadoc tag ?

Sounds like a plan! But we still have a "dispute", some favour an approach where we instead implement a kotlin kdoc, scala doc and groovy doc parser as well. I am pretty sure if we went that way (ie support external parsers for other JVM languages), we should provide the appropriate parsers/extractors as well. This option here is WAY simpler, but not necessarily better. Maybe this should go to the mailing list AGAIN? WDYT?

bmarwell avatar Nov 16 '22 18:11 bmarwell