Skip to main content

[jsr363-experts] Re: Javadoc formatting

  • From: Werner Keil < >
  • To: " " < >
  • Subject: [jsr363-experts] Re: Javadoc formatting
  • Date: Wed, 17 Dec 2014 11:11:58 +0100

I would not complicate it by the colorapi plugin.
I am not sure, if that plugin was maintained to work with later JavaDoc
additions by Java 8 or 9, etc. and if it's neither on MavenCentral nor
accepted alternatives like JCenter it would make it hard for any user to
build our code.

I changed [code] to <code> that's an official part of JavaDoc, why should
we use <pre>?

Werner

On Wed, Dec 17, 2014 at 6:50 AM, Martin Desruisseaux <
>
 wrote:
>
>  Javadoc comments in JSR-363 API use custom [code] blocks, which were
> processed in a special way by the colorapi plugin. This plugin is not
> executed anymore at this time, which result in broken javadoc formatting.
> What should we do?
>
>    - Replace [code] by standard HTML <pre> elements?
>    - Reenable the colorapi plugin in the pom.xml?
>
> The colorapi plugin does not seem to be on Maven central repository, which
> may prevent us from using it. Furthermore replacing by the HTML element
> would allow the code example to be formatted as expected in auto-completion
> windows of IDE that do not know about custom plugins. Do we perform this
> replacement?
>
>     Martin
>
>


[jsr363-experts] Javadoc formatting

Martin Desruisseaux 12/17/2014

[jsr363-experts] Re: Javadoc formatting

Werner Keil 12/17/2014

[jsr363-experts] Re: Javadoc formatting

Martin Desruisseaux 12/17/2014

[jsr363-experts] Re: Javadoc formatting

Werner Keil 12/17/2014
 
 
Close
loading
Please Confirm
Close