From add57d4066e78f200b0a884cb36ba799a6566b11 Mon Sep 17 00:00:00 2001 From: Ilkka Seppala Date: Wed, 19 Aug 2015 22:09:54 +0300 Subject: [PATCH] #107 Improve JavaDoc for Lazy Loading example --- .../src/main/java/com/iluwatar/lazy/loading/App.java | 8 ++++++-- .../main/java/com/iluwatar/lazy/loading/Java8Holder.java | 4 ++-- .../src/test/java/com/iluwatar/lazy/loading/AppTest.java | 5 +++++ 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/lazy-loading/src/main/java/com/iluwatar/lazy/loading/App.java b/lazy-loading/src/main/java/com/iluwatar/lazy/loading/App.java index f12d4e20c..db09c781b 100644 --- a/lazy-loading/src/main/java/com/iluwatar/lazy/loading/App.java +++ b/lazy-loading/src/main/java/com/iluwatar/lazy/loading/App.java @@ -3,16 +3,20 @@ package com.iluwatar.lazy.loading; /** * * Lazy loading idiom defers object creation until needed. - * + *

* This example shows different implementations of the pattern * with increasing sophistication. - * + *

* Additional information and lazy loading flavours are described in * http://martinfowler.com/eaaCatalog/lazyLoad.html * */ public class App { + /** + * Program entry point + * @param args command line args + */ public static void main( String[] args ) { // Simple lazy loader - not thread safe diff --git a/lazy-loading/src/main/java/com/iluwatar/lazy/loading/Java8Holder.java b/lazy-loading/src/main/java/com/iluwatar/lazy/loading/Java8Holder.java index 6bd2382c1..a03aae352 100644 --- a/lazy-loading/src/main/java/com/iluwatar/lazy/loading/Java8Holder.java +++ b/lazy-loading/src/main/java/com/iluwatar/lazy/loading/Java8Holder.java @@ -4,8 +4,8 @@ import java.util.function.Supplier; /** * - * This lazy loader is thread safe and more efficient than HolderThreadSafe. - * It utilizes Java 8 functional interface Supplier as Heavy factory. + * This lazy loader is thread safe and more efficient than {@link HolderThreadSafe}. + * It utilizes Java 8 functional interface {@link Supplier} as {@link Heavy} factory. * */ public class Java8Holder { diff --git a/lazy-loading/src/test/java/com/iluwatar/lazy/loading/AppTest.java b/lazy-loading/src/test/java/com/iluwatar/lazy/loading/AppTest.java index 96e88e75f..0ef7e8ae2 100644 --- a/lazy-loading/src/test/java/com/iluwatar/lazy/loading/AppTest.java +++ b/lazy-loading/src/test/java/com/iluwatar/lazy/loading/AppTest.java @@ -4,6 +4,11 @@ import org.junit.Test; import com.iluwatar.lazy.loading.App; +/** + * + * Application test + * + */ public class AppTest { @Test