20 Sep
2016
20 Sep
'16
10:45 a.m.
On 20 Sep 2016, at 10:42, Denis Gervalle
<dgl(a)softec.lu> wrote:
On mar., sept. 20, 2016 at 10:24 AM, Vincent Massol <vincent(a)massol.net> wrote: Hi
devs,
I’d like to propose that we standardized on using multiple @since tags for multiple
versions in order to be more semantic and not have to invent a syntax (that then needs to
be followed and parsed)
Instead of:
@since 8.4.5, 8.3RC1
Use:
@since 8.4.5
@since 8.3RC1
This is supported by the javadoc, see
http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a…
Also note that our Unstable annotation checker needs to be in sync (I’ve opened
http://jira.xwiki.org/browse/XCOMMONS-1071 in advance).
The main rationale is that it’s more semantic to have one since per version (similar to
having one author par author).
WDYT?
+1, but do we list them ascending, descending, any order ?
haha… I don’t think we need to define an order since the version it itself representing an
order.
If we really want a best practice I’d propose from lower to higher (7.4.5 before 8.2.2
even though 7.4.5 could be released before 8.2.2 ;)).
Thanks
-Vincent
Thanks
-Vincent
PS: I have already made changes for commons and waiting for agreement before committing
or discarding ;)