Skip to content

Commit

Permalink
more javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
yegor256 committed Jun 15, 2017
1 parent 7432dc1 commit 9642efa
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/main/java/org/cactoos/Func.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,24 @@
/**
* Function.
*
* <p>If you don't want to have any checked exceptions being thrown
* out of your {@link Func}, you can use
* {@link org.cactoos.func.UncheckedFunc} decorator. Also
* you may try {@link org.cactoos.func.IoCheckedFunc}.</p>
*
* <p>If you want to cache the result of the {@link Func} and
* make sure it doesn't calculate anything twice, you can use
* {@link org.cactoos.func.StickyFunc} decorator.</p>
*
* <p>There is no thread-safety guarantee.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id$
* @param <X> Type of input
* @param <Y> Type of output
* @see org.cactoos.func.StickyFunc
* @see org.cactoos.func.UncheckedFunc
* @see org.cactoos.func.IoCheckedFunc
* @since 0.1
*/
public interface Func<X, Y> {
Expand Down
12 changes: 12 additions & 0 deletions src/main/java/org/cactoos/Scalar.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,23 @@
/**
* Scalar.
*
* <p>If you don't want to have any checked exceptions being thrown
* out of your {@link Scalar}, you can use
* {@link org.cactoos.func.UncheckedScalar} decorator. Also
* you may try {@link org.cactoos.func.IoCheckedScalar}.</p>
*
* <p>If you want to cache the result of the {@link Scalar} and
* make sure it doesn't calculate anything twice, you can use
* {@link org.cactoos.func.StickyScalar} decorator.</p>
*
* <p>There is no thread-safety guarantee.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id$
* @param <T> Type of result
* @see org.cactoos.func.StickyScalar
* @see org.cactoos.func.UncheckedScalar
* @see org.cactoos.func.IoCheckedScalar
* @since 0.1
*/
public interface Scalar<T> {
Expand Down

0 comments on commit 9642efa

Please sign in to comment.