Skip to content

Commit

Permalink
Clarified Slices documentation
Browse files Browse the repository at this point in the history
The slices documentation does not mention a very important aspect, that is that, technically, Slices do not represent a given set of packages, although the example shows that.

Signed-off-by: mipo256 <mikhailpolivakha@gmail.com>
  • Loading branch information
mipo256 committed Jan 23, 2025
1 parent 4a0236a commit 51bf9ac
Showing 1 changed file with 5 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@
* The top level packages under 'myapp' could be considered slices according to different domain aspects.<br>
* Thus there could be a slice 'Order' housing all the classes from the {@code order} package, a slice 'Customer'
* housing all the classes from the {@code customer} package and so on.
* <p>
* Note that a {@link Slice} does not necessarily represent a subpackage inside some root package.
* The example above is just a common use case, but a {@link Slice} can technically represent any set
* of {@link JavaClass}es.
* </p>
*/
@PublicAPI(usage = ACCESS)
public final class Slice extends ForwardingSet<JavaClass> implements HasDescription, CanOverrideDescription<Slice> {
Expand Down

0 comments on commit 51bf9ac

Please sign in to comment.