chemistry-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Florian Müller <f...@apache.org>
Subject Re: svn commit: r1483889 [1/3] - in /chemistry/opencmis/trunk: ./ chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/ap...
Date Sat, 18 May 2013 12:15:54 GMT
The @since tag is usually for the library version and this is the 
specification version. I have also adapted the JavaDoc configuration in 
the main pom.xml to recognize this custom tag and format it nicely.
The @cmis tag might avoid confusion later when OpenCMIS reaches the 
versions 1.0 and 1.1.
But if there is consensus to use @since here, I'm fine with that.

- Florian

> This is extremely useful (and a lot of work thanks) but maybe we could
> use a standard Javadoc tag that tools will pick up and display nicely,
> like:
>
>   @since CMIS 1.0
>   @since CMIS 1.1
>
> A quick sed -i could do the change on all the files at once.
>
> Florent
>
> On Fri, May 17, 2013 at 6:05 PM,<fmui@apache.org>  wrote:
>> more JavaDoc
>
>> @@ -61,60 +61,80 @@ public interface CmisObjectProperties {
>>       /**
>>        * Returns the name of this CMIS object (CMIS property
>>        *<code>cmis:name</code>).
>> +     *
>> +     * @cmis 1.0
>>        */
>>       String getName();
>>
>>       /**
>>        * Returns the description of this CMIS object (CMIS property
>>        *<code>cmis:description</code>).
>> +     *
>> +     * @cmis 1.1
>>        */
>>       String getDescription();
>>
>
>
> --
> Florent Guillaume, Director of R&D, Nuxeo
> Open Source, Java EE based, Enterprise Content Management (ECM)
> http://www.nuxeo.com   http://www.nuxeo.org   +33 1 40 33 79 87
>

Mime
View raw message