'Re: [Dev] [maven-tools] Usage of java 5 annotations over javadoc tags for maven plugin development'

[prev in list] [next in list] [prev in thread] [next in thread] 

List:       wsas-java-dev
Subject:    Re: [Dev] [maven-tools] Usage of java 5 annotations over javadoc tags for maven plugin development
From:       Dinusha Boteju <dinushab () wso2 ! com>
Date:       2015-08-31 14:23:41
Message-ID: CACYcy4Sw72kKuTk92AhY64G6SiPfzy-4bGryoTe-qzzCneGWCw () mail ! gmail ! com
[Download RAW message or body]

[Attachment #2 (multipart/alternative)]

Hi Ruwan,

Changes are still not added to this repo. If we are to add these
annotations, we can add to all mojos in [1]. However, I do not think it is
wise to apply these changes to existing working code. Maybe later in a
major release. However, since I have almost refactored feature-gen-goal I
am thinking if moving to java 5 annotations over javadoc annotations.

[1] - https://github.com/wso2/maven-tools

Cheers,
Dinusha

On Mon, Aug 31, 2015 at 9:55 AM, Ruwan Abeykoon <ruwana@wso2.com> wrote:

> Hi Dinusha,
> Thanks, looking good.
> Would you be able to send some links to the maven-tools [1] where we would
> be able to convert to use annotation. I have not seen any place to use
> annotation on "p2-plugin" yet.
>
> [1] https://github.com/wso2/maven-tools
>
> Cheers,
> Ruwan
>
> On Mon, Aug 31, 2015 at 9:44 AM, Dinusha Boteju <dinushab@wso2.com> wrote:
>
>> Hi Ruwan,
>>
>> I was referring maven-plugin-annotations[1].
>>
>> [1] -
>> https://maven.apache.org/plugin-tools/maven-plugin-plugin/examples/using-annotations.html
>>
>>
>> On Sun, Aug 30, 2015 at 7:25 PM, Ruwan Abeykoon <ruwana@wso2.com> wrote:
>>
>>> Hi Dinusha,
>>> +1 on moving to annotation (if any), because compiler can properly
>>> verify most of the syntax than with javadocs.
>>>
>>> I may be wrong, but I have not seen, current "carbon-p2-plugin" has any
>>> javadoc tags though. Are you referring felix-scr plugin javdocs?
>>>
>>>
>>> Cheers,
>>> Ruwan
>>>
>>> On Sat, Aug 29, 2015 at 1:06 PM, Dinusha Boteju <dinushab@wso2.com>
>>> wrote:
>>>
>>>> Hi devs,
>>>>
>>>> I am in the process of redesigning and refactoring carbon-p2-plugin.
>>>> This is a module in the maven-tools project. While I was checking these
>>>> plugins I noted that these mojos are written using javadoc tags. Since I am
>>>> in the process of redesigning the p2 plugin I was thinking whether to use
>>>> java 5 annotations for this[1]. So plugin developers, I would like to have
>>>> your thoughts on this.
>>>>
>>>> [1] -
>>>>  https://maven.apache.org/plugin-tools/maven-plugin-plugin/examples/using-annotations.html
>>>> <https://maven.apache.org/plugin-tools/maven-plugin-plugin/examples/using-annotations.html>
>>>> [2] -
>>>> https://maven.apache.org/plugin-tools/maven-plugin-tools-annotations/index.html
>>>> [3] -
>>>> https://maven.apache.org/components/plugin-tools/maven-plugin-tools-java/
>>>>
>>>> Thanks,
>>>> --
>>>>
>>>> *Dinusha Boteju*
>>>> *WSO2, Inc. http://wso2.com <http://wso2.com/> *
>>>> *lean.enterprise.middleware.*
>>>>
>>>> email: dinushab@wso2.com <ruwana@wso2.com>
>>>> phone:(+94) 776640275 <%28%2B94%29%20777739736>
>>>>
>>>> _______________________________________________
>>>> Dev mailing list
>>>> Dev@wso2.org
>>>> http://wso2.org/cgi-bin/mailman/listinfo/dev
>>>>
>>>>
>>>
>>>
>>> --
>>>
>>> *Ruwan Abeykoon*
>>> *Architect,*
>>> *WSO2, Inc. http://wso2.com <http://wso2.com/> *
>>> *lean.enterprise.middleware.*
>>>
>>> email: ruwana@wso2.com
>>>
>>
>>
>>
>> --
>>
>> *Dinusha Boteju*
>> *Associate Tech Lead,*
>> *WSO2, Inc. http://wso2.com <http://wso2.com/> *
>> *lean.enterprise.middleware.*
>>
>> email: dinushab@wso2.com <ruwana@wso2.com>
>> phone:(+94) 776640275 <%28%2B94%29%20777739736>
>>
>
>
>
> --
>
> *Ruwan Abeykoon*
> *Architect,*
> *WSO2, Inc. http://wso2.com <http://wso2.com/> *
> *lean.enterprise.middleware.*
>
> email: ruwana@wso2.com
>

-- 

*Dinusha Boteju*
*Associate Tech Lead,*
*WSO2, Inc. http://wso2.com <http://wso2.com/> *
*lean.enterprise.middleware.*

email: dinushab@wso2.com <ruwana@wso2.com>
phone:(+94) 776640275 <%28%2B94%29%20777739736>

[Attachment #5 (text/html)]

<div dir="ltr"><div><div><div>Hi Ruwan,<br><br></div>Changes are still not added to \
this repo. If we are to add these annotations, we can add to all mojos in [1]. \
However, I do not think it is wise to apply these changes to existing working code. \
Maybe later in a major release. However, since I have almost refactored \
feature-gen-goal I am thinking if moving to java 5 annotations over javadoc \
annotations.<br><br>[1] - <a \
href="https://github.com/wso2/maven-tools">https://github.com/wso2/maven-tools</a><br><br></div>Cheers,<br></div>Dinusha<br><br></div><div \
class="gmail_extra"><br><div class="gmail_quote">On Mon, Aug 31, 2015 at 9:55 AM, \
Ruwan Abeykoon <span dir="ltr">&lt;<a href="mailto:ruwana@wso2.com" \
target="_blank">ruwana@wso2.com</a>&gt;</span> wrote:<br><blockquote \
class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc \
solid;padding-left:1ex"><div dir="ltr">Hi Dinusha,<div>Thanks, looking good.  \
</div><div>Would you be able to send some links to the maven-tools [1] where we would \
be able to convert to use annotation. I have not seen any place to use annotation on \
&quot;p2-plugin&quot; yet.</div><div><br></div><div>[1]  <a \
href="https://github.com/wso2/maven-tools" \
target="_blank">https://github.com/wso2/maven-tools</a></div><div><br></div><div>Cheers,</div><div>Ruwan</div></div><div \
class="HOEnZb"><div class="h5"><div class="gmail_extra"><br><div \
class="gmail_quote">On Mon, Aug 31, 2015 at 9:44 AM, Dinusha Boteju <span \
dir="ltr">&lt;<a href="mailto:dinushab@wso2.com" \
target="_blank">dinushab@wso2.com</a>&gt;</span> wrote:<br><blockquote \
class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc \
solid;padding-left:1ex"><div dir="ltr"><div>Hi Ruwan,<br><br></div>I was referring  \
<tt>maven-plugin-annotations[1].</tt><br><br>[1] - <a \
href="https://maven.apache.org/plugin-tools/maven-plugin-plugin/examples/using-annotations.html" \
target="_blank">https://maven.apache.org/plugin-tools/maven-plugin-plugin/examples/using-annotations.html</a><tt><br><br></tt></div><div \
class="gmail_extra"><div><div><br><div class="gmail_quote">On Sun, Aug 30, 2015 at \
7:25 PM, Ruwan Abeykoon <span dir="ltr">&lt;<a href="mailto:ruwana@wso2.com" \
target="_blank">ruwana@wso2.com</a>&gt;</span> wrote:<br><blockquote \
class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc \
solid;padding-left:1ex"><div dir="ltr">Hi Dinusha,<div>+1 on moving to annotation (if \
any), because compiler can properly verify most of the syntax than with \
javadocs.</div><div><br></div><div>I may be wrong, but I have not seen, current \
&quot;carbon-p2-plugin&quot; has any javadoc tags though. Are you referring felix-scr \
plugin javdocs?</div><div><br></div><div><br></div><div>Cheers,</div><div>Ruwan</div></div><div \
class="gmail_extra"><br><div class="gmail_quote"><div><div>On Sat, Aug 29, 2015 at \
1:06 PM, Dinusha Boteju <span dir="ltr">&lt;<a href="mailto:dinushab@wso2.com" \
target="_blank">dinushab@wso2.com</a>&gt;</span> wrote:<br></div></div><blockquote \
class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc \
solid;padding-left:1ex"><div><div><div dir="ltr"><div><span \
style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:small;font-style:nor \
mal;font-variant:normal;font-weight:normal;letter-spacing:normal;line-height:normal;te \
xt-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;display:inline!important;float:none;background-color:rgb(255,255,255)">Hi \
devs,</span><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:sma \
ll;font-style:normal;font-variant:normal;font-weight:normal;letter-spacing:normal;line \
-height:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px"><br></div><div \
style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:small;font-style:nor \
mal;font-variant:normal;font-weight:normal;letter-spacing:normal;line-height:normal;te \
xt-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px">I \
am in the process of redesigning and refactoring carbon-p2-plugin. This is a module \
in the maven-tools project. While I was checking these plugins I noted that these \
mojos are written using javadoc tags. Since I am in the process of redesigning the p2 \
plugin I was thinking whether to use java 5 annotations for this[1]. So plugin \
developers, I would like to have your thoughts on this.</div><div \
style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:small;font-style:nor \
mal;font-variant:normal;font-weight:normal;letter-spacing:normal;line-height:normal;te \
xt-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px"><br></div><div \
style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:small;font-style:nor \
mal;font-variant:normal;font-weight:normal;letter-spacing:normal;line-height:normal;te \
xt-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px">[1] \
-<a href="https://maven.apache.org/plugin-tools/maven-plugin-plugin/examples/using-annotations.html" \
style="color:rgb(17,85,204)" target="_blank">  \
https://maven.apache.org/plugin-tools/maven-plugin-plugin/examples/using-annotations.html</a></div>[2] \
- <a href="https://maven.apache.org/plugin-tools/maven-plugin-tools-annotations/index.html" \
target="_blank">https://maven.apache.org/plugin-tools/maven-plugin-tools-annotations/index.html</a><br>[3] \
- <a href="https://maven.apache.org/components/plugin-tools/maven-plugin-tools-java/" \
target="_blank">https://maven.apache.org/components/plugin-tools/maven-plugin-tools-java/</a><br><br \
clear="all"></div>Thanks,<span><font color="#888888"><br><div>-- <br><div><div \
dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><font color="#444444" \
face="georgia, serif"><b>Dinusha Boteju<br></b></font><span><font \
color="#888888"><div><div dir="ltr"><div><div dir="ltr"><div \
style="color:rgb(136,136,136)"><div><font color="#444444" face="times new roman, \
serif"><b>WSO2, Inc.  <a href="http://wso2.com/" style="color:rgb(17,85,204)" \
target="_blank">http://wso2.com</a>  </b></font></div><div><font color="#444444" \
face="times new roman, \
serif"><b>lean.enterprise.middleware.</b></font></div></div><div \
style="color:rgb(136,136,136)"><font color="#444444" face="georgia, \
serif"><b><br></b></font></div><div style="color:rgb(136,136,136)"><font \
color="#444444" size="1">email: <a href="mailto:ruwana@wso2.com" \
style="color:rgb(17,85,204)" target="_blank">dinushab@wso2.com</a>  </font></div><div \
style="color:rgb(136,136,136)"><font color="#444444" size="1">phone:<a \
href="tel:%28%2B94%29%20777739736" value="+94777911226" style="color:rgb(17,85,204)" \
target="_blank">(+94) \
776640275</a></font></div></div></div></div></div></font></span></div></div></div></div></div></div>
 </div></font></span></div>
<br></div></div>_______________________________________________<br>
Dev mailing list<br>
<a href="mailto:Dev@wso2.org" target="_blank">Dev@wso2.org</a><br>
<a href="http://wso2.org/cgi-bin/mailman/listinfo/dev" rel="noreferrer" \
target="_blank">http://wso2.org/cgi-bin/mailman/listinfo/dev</a><br> \
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div><div \
dir="ltr"><div><div dir="ltr"><div dir="ltr"><font color="#444444" face="georgia, \
serif"><b>Ruwan Abeykoon<br></b></font><div style="color:rgb(136,136,136)"><div><font \
color="#444444" face="times new roman, \
serif"><b>Architect,</b></font></div><span><div><font color="#444444" face="times new \
roman, serif"><b>WSO2, Inc.  <a href="http://wso2.com/" style="color:rgb(17,85,204)" \
target="_blank">http://wso2.com</a>  </b></font></div><div><font color="#444444" \
face="times new roman, \
serif"><b>lean.enterprise.middleware.</b></font></div></span></div><div \
style="color:rgb(136,136,136)"><font color="#444444" face="georgia, \
serif"><b><br></b></font></div><div style="color:rgb(136,136,136)"><font \
color="#444444" size="1">email:  <a href="mailto:ruwana@wso2.com" \
style="color:rgb(17,85,204)" target="_blank">ruwana@wso2.com</a>  \
</font></div></div></div></div></div></div> </div>
</blockquote></div><br><br clear="all"><br></div></div><span><font color="#888888">-- \
<br></font></span><div><div dir="ltr"><div><div dir="ltr"><div><div \
dir="ltr"><span><font color="#888888"><font color="#444444" face="georgia, \
serif"><b>Dinusha Boteju<br></b></font></font></span><span><font \
color="#888888"><div><div dir="ltr"><div><div dir="ltr"><div \
style="color:rgb(136,136,136)"><span><font color="#888888"><div><font color="#444444" \
face="times new roman, serif"><b>Associate Tech \
Lead,</b></font></div></font></span><span><div><font color="#444444" face="times new \
roman, serif"><b>WSO2, Inc.  <a href="http://wso2.com/" style="color:rgb(17,85,204)" \
target="_blank">http://wso2.com</a>  </b></font></div><div><font color="#444444" \
face="times new roman, \
serif"><b>lean.enterprise.middleware.</b></font></div></span></div><span><div \
style="color:rgb(136,136,136)"><font color="#444444" face="georgia, \
serif"><b><br></b></font></div><div style="color:rgb(136,136,136)"><font \
color="#444444" size="1">email: <a href="mailto:ruwana@wso2.com" \
style="color:rgb(17,85,204)" target="_blank">dinushab@wso2.com</a>  </font></div><div \
style="color:rgb(136,136,136)"><font color="#444444" size="1">phone:<a \
href="tel:%28%2B94%29%20777739736" value="+94777911226" style="color:rgb(17,85,204)" \
target="_blank">(+94) \
776640275</a></font></div></span></div></div></div></div></font></span></div></div></div></div></div></div>
 </div>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div><div \
dir="ltr"><div><div dir="ltr"><div dir="ltr"><font color="#444444" face="georgia, \
serif"><b>Ruwan Abeykoon<br></b></font><div style="color:rgb(136,136,136)"><div><font \
color="#444444" face="times new roman, \
serif"><b>Architect,</b></font></div><div><font color="#444444" face="times new \
roman, serif"><b>WSO2, Inc.  <a href="http://wso2.com/" style="color:rgb(17,85,204)" \
target="_blank">http://wso2.com</a>  </b></font></div><div><font color="#444444" \
face="times new roman, \
serif"><b>lean.enterprise.middleware.</b></font></div></div><div \
style="color:rgb(136,136,136)"><font color="#444444" face="georgia, \
serif"><b><br></b></font></div><div style="color:rgb(136,136,136)"><font \
color="#444444" size="1">email:  <a href="mailto:ruwana@wso2.com" \
style="color:rgb(17,85,204)" target="_blank">ruwana@wso2.com</a>  \
</font></div></div></div></div></div></div> </div>
</div></div></blockquote></div><br><br clear="all"><br>-- <br><div \
class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><font \
color="#444444" face="georgia, serif"><b>Dinusha Boteju<br></b></font><span><font \
color="#888888"><div><div dir="ltr"><div><div dir="ltr"><div \
style="color:rgb(136,136,136)"><div><font color="#444444" face="times new roman, \
serif"><b>Associate Tech Lead,</b></font></div><div><font color="#444444" face="times \
new roman, serif"><b>WSO2, Inc.  <a href="http://wso2.com/" \
style="color:rgb(17,85,204)" target="_blank">http://wso2.com</a>  \
</b></font></div><div><font color="#444444" face="times new roman, \
serif"><b>lean.enterprise.middleware.</b></font></div></div><div \
style="color:rgb(136,136,136)"><font color="#444444" face="georgia, \
serif"><b><br></b></font></div><div style="color:rgb(136,136,136)"><font \
color="#444444" size="1">email: <a href="mailto:ruwana@wso2.com" \
style="color:rgb(17,85,204)" target="_blank">dinushab@wso2.com</a>  </font></div><div \
style="color:rgb(136,136,136)"><font color="#444444" size="1">phone:<a \
href="tel:%28%2B94%29%20777739736" value="+94777911226" style="color:rgb(17,85,204)" \
target="_blank">(+94) \
776640275</a></font></div></div></div></div></div></font></span></div></div></div></div></div></div>
 </div>

_______________________________________________
Dev mailing list
Dev@wso2.org
http://wso2.org/cgi-bin/mailman/listinfo/dev

[prev in list] [next in list] [prev in thread] [next in thread] 