No mock classes in API documentation?

[Jason E Bailey <je...@apache.org>]

Was looking up a class and the last time it was in the API was Sling 6.
Was that intentional?
- Jason

Re: No mock classes in API documentation?

[Jason E Bailey <je...@apache.org>]

Then there's a lack of clarity then in what goes into the published API specification. The testing mock is part of Apache Sling, it's hosted and developed by this Project. Is there anything that states that the Only API that we are publishing is those bundles that are specifically part of the launchpad/starter?

If there are first and second class bundles, why aren't they separated out on the downloads page for clarification? 

And although I appreciate that you have  the API's available. My personal opinion is that an Apache Project should host the API documentation itself and not rely on a third party.

- Jason

On Mon, Apr 9, 2018, at 10:10 AM, Stefan Seifert wrote:
> do you mean from sling-mock, osgi-mock, jcr-mock?
> i think it makes sense to not include them in the API docs because they 
> are not available at runtime but only for for test code. and they are 
> not "released" together with the each sling major version, they are not 
> included in the launchpad/starter.
> 
> on the other side the API from those modules (and from other testing 
> modules) are not documented in any published api docs them - not sure if 
> it makes sense to publish a separate "Testing API" docs for them.
> 
> as a workaround you can use [1] which contains the apidocs for the sling 
> mocks as well.
> 
> stefan
> 
> [1] http://wcm.io/testing/aem-mock/apidocs/
> 
> 
> >-----Original Message-----
> >From: Jason E Bailey [mailto:jeb@apache.org]
> >Sent: Sunday, April 1, 2018 4:10 PM
> >To: dev@sling.apache.org
> >Subject: No mock classes in API documentation?
> >
> >Was looking up a class and the last time it was in the API was Sling 6.
> >Was that intentional?
> >- Jason
> >
> 

RE: No mock classes in API documentation?

[Stefan Seifert <ss...@pro-vision.de>]

do you mean from sling-mock, osgi-mock, jcr-mock?
i think it makes sense to not include them in the API docs because they are not available at runtime but only for for test code. and they are not "released" together with the each sling major version, they are not included in the launchpad/starter.

on the other side the API from those modules (and from other testing modules) are not documented in any published api docs them - not sure if it makes sense to publish a separate "Testing API" docs for them.

as a workaround you can use [1] which contains the apidocs for the sling mocks as well.

stefan

[1] http://wcm.io/testing/aem-mock/apidocs/


>-----Original Message-----
>From: Jason E Bailey [mailto:jeb@apache.org]
>Sent: Sunday, April 1, 2018 4:10 PM
>To: dev@sling.apache.org
>Subject: No mock classes in API documentation?
>
>Was looking up a class and the last time it was in the API was Sling 6.
>Was that intentional?
>- Jason
>