Skip to content

Commit e76b998

Browse files
authored
javadocs
1 parent d216ea5 commit e76b998

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/main/java/com/amihaiemil/docker/Containers.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
import java.util.Iterator;
3131

3232
/**
33-
* Containers API.
33+
* Containers API. This is also an Iterable over the running containers.
34+
* If you need an Iterable over all the containers, use the .all() method.
3435
* @author Mihai Andronache ([email protected])
3536
* @version $Id$
3637
* @since 0.0.1
@@ -74,8 +75,7 @@ Container create(
7475
Container create(final JsonObject container) throws IOException;
7576

7677
/**
77-
* Return all the Containers, not only the running ones (simply iterating
78-
* over this Containers instance will fetch only the running ones).
78+
* Return all the Containers, not only the running ones.
7979
* @return Iterator over all the containers.
8080
*/
8181
Iterator<Container> all();

0 commit comments

Comments
 (0)