Plugins separated API (Javadoc)?

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
6 messages Options
Reply | Threaded
Open this post in threaded view
|

Plugins separated API (Javadoc)?

Jacques Le Roux
Administrator
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

Reply | Threaded
Open this post in threaded view
|

Re: Plugins separated API (Javadoc)?

taher
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 <
[hidden email]> 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
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Plugins separated API (Javadoc)?

Pierre Smits
In reply to this post by Jacques Le Roux
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 <
[hidden email]> 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
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Plugins separated API (Javadoc)?

Jacques Le Roux
Administrator
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 <
> [hidden email]> 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
>>
>>

Reply | Threaded
Open this post in threaded view
|

Re: Plugins separated API (Javadoc)?

Pierre Smits
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 <
[hidden email]> 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 <
>> [hidden email]> 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
>>>
>>>
>>>
>
Reply | Threaded
Open this post in threaded view
|

Re: Plugins separated API (Javadoc)?

Jacques Le Roux
Administrator
In reply to this post by taher
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 <
> [hidden email]> 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
>>
>>