You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ofbiz.apache.org by Jacques Le Roux <ja...@les7arts.com> on 2017/03/20 11:56:03 UTC

Plugins separated API (Javadoc)?

Hi,

Currently the plugins branch has no means to create Javadoc, nor any others actually (not Gradle there)

If we want the Plugins to be a real apart product should we not worry about that?

Thanks

Jacques


Re: Plugins separated API (Javadoc)?

Posted by Pierre Smits <pi...@gmail.com>.
We could take a hint from the Apache Commons project.

Best regards,

Pierre Smits

ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services

OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/

On Mon, Mar 20, 2017 at 1:42 PM, Jacques Le Roux <
jacques.le.roux@les7arts.com> wrote:

> It's not yet clear to me, but I guess at 99% the entire branch (only ASF
> has a repo, not products they have only branches)
>
> Managing plugins as separated products would be a real pain for the
> release manager. Except if we can delegate...
>
> Jacques
>
>
> Le 20/03/2017 à 13:19, Pierre Smits a écrit :
>
>> Is the entire repo a product? Or are the individual components?
>>
>> Best regards,
>>
>> Pierre Smits
>>
>> ORRTIZ.COM <http://www.orrtiz.com>
>> OFBiz based solutions & services
>>
>> OFBiz Extensions Marketplace
>> http://oem.ofbizci.net/oci-2/
>>
>> On Mon, Mar 20, 2017 at 12:56 PM, Jacques Le Roux <
>> jacques.le.roux@les7arts.com> wrote:
>>
>> Hi,
>>>
>>> Currently the plugins branch has no means to create Javadoc, nor any
>>> others actually (not Gradle there)
>>>
>>> If we want the Plugins to be a real apart product should we not worry
>>> about that?
>>>
>>> Thanks
>>>
>>> Jacques
>>>
>>>
>>>
>

Re: Plugins separated API (Javadoc)?

Posted by Jacques Le Roux <ja...@les7arts.com>.
It's not yet clear to me, but I guess at 99% the entire branch (only ASF has a repo, not products they have only branches)

Managing plugins as separated products would be a real pain for the release manager. Except if we can delegate...

Jacques


Le 20/03/2017 � 13:19, Pierre Smits a �crit :
> Is the entire repo a product? Or are the individual components?
>
> Best regards,
>
> Pierre Smits
>
> ORRTIZ.COM <http://www.orrtiz.com>
> OFBiz based solutions & services
>
> OFBiz Extensions Marketplace
> http://oem.ofbizci.net/oci-2/
>
> On Mon, Mar 20, 2017 at 12:56 PM, Jacques Le Roux <
> jacques.le.roux@les7arts.com> wrote:
>
>> Hi,
>>
>> Currently the plugins branch has no means to create Javadoc, nor any
>> others actually (not Gradle there)
>>
>> If we want the Plugins to be a real apart product should we not worry
>> about that?
>>
>> Thanks
>>
>> Jacques
>>
>>


Re: Plugins separated API (Javadoc)?

Posted by Pierre Smits <pi...@gmail.com>.
Is the entire repo a product? Or are the individual components?

Best regards,

Pierre Smits

ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services

OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/

On Mon, Mar 20, 2017 at 12:56 PM, Jacques Le Roux <
jacques.le.roux@les7arts.com> wrote:

> Hi,
>
> Currently the plugins branch has no means to create Javadoc, nor any
> others actually (not Gradle there)
>
> If we want the Plugins to be a real apart product should we not worry
> about that?
>
> Thanks
>
> Jacques
>
>

Re: Plugins separated API (Javadoc)?

Posted by Jacques Le Roux <ja...@les7arts.com>.
OK, let's wait

Jacques


Le 20/03/2017 � 13:12, Taher Alkhateeb a �crit :
> Too early and too messy to worry about it at the moment. The plugins
> require a lot of refactoring work and some plugins need to be deleted
> altogether (ebaystore, ebay, etc ..). Just run ./gradlew javadoc and
> observe how many problems are there.
>
> To have any real value of JavaDocs, we need to cleanup the docs in the
> first place. Most of the JavaDocs in our java code base are either a)
> non-existent or b) poorly formatted for javadoc output. I for one never use
> any javadocs to investigate the code base because I know right now it's not
> very reliable and you have to dig through the code to get a real
> understanding.
>
> On Mon, Mar 20, 2017 at 2:56 PM, Jacques Le Roux <
> jacques.le.roux@les7arts.com> wrote:
>
>> Hi,
>>
>> Currently the plugins branch has no means to create Javadoc, nor any
>> others actually (not Gradle there)
>>
>> If we want the Plugins to be a real apart product should we not worry
>> about that?
>>
>> Thanks
>>
>> Jacques
>>
>>


Re: Plugins separated API (Javadoc)?

Posted by Taher Alkhateeb <sl...@gmail.com>.
Too early and too messy to worry about it at the moment. The plugins
require a lot of refactoring work and some plugins need to be deleted
altogether (ebaystore, ebay, etc ..). Just run ./gradlew javadoc and
observe how many problems are there.

To have any real value of JavaDocs, we need to cleanup the docs in the
first place. Most of the JavaDocs in our java code base are either a)
non-existent or b) poorly formatted for javadoc output. I for one never use
any javadocs to investigate the code base because I know right now it's not
very reliable and you have to dig through the code to get a real
understanding.

On Mon, Mar 20, 2017 at 2:56 PM, Jacques Le Roux <
jacques.le.roux@les7arts.com> wrote:

> Hi,
>
> Currently the plugins branch has no means to create Javadoc, nor any
> others actually (not Gradle there)
>
> If we want the Plugins to be a real apart product should we not worry
> about that?
>
> Thanks
>
> Jacques
>
>