Re: Plugins documentations - improvements

2023-12-24 Thread Michael Osipov
Am 2023-12-24 um 13:43 schrieb Slawomir Jaranowski: niedz., 24 gru 2023 o 10:30 Hervé Boutemy napisał(a): notice that it is also the javadoc spirit: when there is a long multi-line description, table is expected to keep only first line and detail the full description It is also a good idea

Re: Plugins documentations - improvements

2023-12-24 Thread Slawomir Jaranowski
niedz., 24 gru 2023 o 10:30 Hervé Boutemy napisał(a): > notice that it is also the javadoc spirit: when there is a long multi-line > description, table is expected to keep only first line and detail the full > description > > It is also a good idea ... So we should only put in table first line,

Re: Plugins documentations - improvements

2023-12-24 Thread Hervé Boutemy
notice that it is also the javadoc spirit: when there is a long multi-line description, table is expected to keep only first line and detail the full description Le samedi 23 décembre 2023, 23:29:22 CET Konrad Windszus a écrit : > Hi, > currently those sections deviate slightly (e.g. the

Re: Plugins documentations - improvements

2023-12-23 Thread Konrad Windszus
Hi, currently those sections deviate slightly (e.g. the overview does not evaluate deprecation info) but we can probably consolidate overview and details into one section. Look at

Re: Plugins documentations - improvements

2023-12-23 Thread Michael Osipov
Am 2023-12-23 um 12:42 schrieb Slawomir Jaranowski: Hi, We have generated plugins documentations by Maven Plugin Report Plugin In generated documentation by gola we have: - introduction sections describe plugin goal - required and optional parameters sections - which describe parameters in

Re: Plugins documentations - improvements

2023-12-23 Thread Hervé Boutemy
in early days, from memory, there were a few fields displayed only in the details section https://maven.apache.org/plugins-archives/maven-compiler-plugin-2.2/compile-mojo.html like expression: I don't find anything else (perhaps even older reports had more fields like this one) but you're

Plugins documentations - improvements

2023-12-23 Thread Slawomir Jaranowski
Hi, We have generated plugins documentations by Maven Plugin Report Plugin In generated documentation by gola we have: - introduction sections describe plugin goal - required and optional parameters sections - which describe parameters in table We also have "Parameter Details" sections which