jakartaee / persistence

https://jakartaee.github.io/persistence/
Other
203 stars 59 forks source link

Update sample code in javadoc to use @snippet #508

Closed lukasj closed 11 months ago

lukasj commented 1 year ago

JEP 413 included in SE 18+ introduced @snippet tag to simplify inclusion of example source code in API documentation - see ie javamagazine

Given that this tag is specific to the version of javadoc tool being used, it should have no impact on the source/binary level of the code - and my quick test (on OpenJDK Runtime Environment (build 21+35-2513)) has proven that.

So if we want to use the @snippet tag now for 3.2, then the build has to require SE 18+ (21 is preferred since that is going to be LTS) and use that in combination with release=17. The only drawback I can see here is that consumers who want to rebuild our sources with javadoc will be required to use SE 18+ as well.

@ivargrimstad / @edburns - just to doublecheck - the EE 11 platform is going to rebuild all included component specs by SE 21, correct?